README

   1 Pachi can refer to: a simple modular framework for programs playing
   2 the game of Go/Weiqi/Baduk, and a reasonably strong engine built
   3 within this framework.
   4
   5
   6 Installation
   7 ------------
   8
   9 To build Pachi, simply type:
  10
  11         make
  12
  13 The resulting binary program `pachi` is a GTP client; connect to it
  14 with your favorite Go program interface (e.g. gogui or qgo), or use
  15 kgsGtp to connect it to KGS.  (DO NOT make the GTP interface accessible
  16 directly to untrusted users since the parser is not secure - see the
  17 HACKING file for details.)
  18
  19 The pachi program can take many parameters, as well as the particular
  20 engine being used; the defaults should be fine for initial usage,
  21 see below for some more tips.
  22
  23 In case you hit compilation issues (e.g. when building on MacOS/X)
  24 or want to change the build configuration, check the user configurable
  25 section at the top of the Makefile.
  26
  27
  28 Engine
  29 ------
  30
  31 The default engine plays by Chinese rules and should be about
  32 3d KGS strength on 9x9. On 19x19, it might be about KGS 2k, assuming
  33 reasonable hardware, e.g. two-core Athlon64 machine.  On a higher-end
  34 (e.g. six-way Intel i7) machine, it can hold a solid KGS 1d rank.
  35 When using a large cluster (64 machines, 20 cores each), it maintains
  36 KGS 3d and has won a 7-stone handicap game against Zhou Junxun 9p.
  37
  38 By default, Pachi currently uses the UCT engine that combines
  39 Monte Carlo approach with tree search; UCB1AMAF tree policy using
  40 the RAVE method is used for tree search, while the Moggy playout
  41 policy using 3x3 patterns and various tactical checks is used for
  42 the semi-random Monte Carlo playouts.
  43
  44 At the same time, we keep trying a wide variety of other approaches
  45 and enhancements. Pachi is an active research platform and quite a few
  46 improvements have been already achieved. We rigorously play-test new
  47 features and enable them by default only when they give a universal
  48 strength boost.
  49
  50 How to run
  51 ~~~~~~~~~~
  52
  53 By default, Pachi will run on a single CPU core, taking up to 1.4GiB
  54 of memory, not pondering and taking completely arbitrary amount of time
  55 per turn. You can adjust these parameters by passing it extra command
  56 line options:
  57
  58         ./pachi -t _1200 threads=8,max_tree_size=3072,pondering
  59
  60 This will make Pachi play with time settings 20:00 S.D. (unless it
  61 gets told otherwise over GTP), with 8 threads, taking up to 3GiB
  62 of memory (+ several tens MiB as a constant overhead) and thinking
  63 during the opponent's turn as well.
  64
  65 Pachi can use an opening book in a Fuego-compatible format - you can
  66 obtain one at http://gnugo.baduk.org/fuegoob.htm and use it in Pachi
  67 with the -f parameter:
  68
  69         ./pachi -f book.dat ...
  70
  71 You may wish to append some custom Pachi opening book lines to book.dat;
  72 take them from the book.dat.extra file. If using the default Fuego book,
  73 you may want to remove the lines listed in book.dat.bad.
  74
  75 Pachi can also use a pattern database to improve its playing performance.
  76 You can get it at http://pachi.or.cz/pat/ - you will also find further
  77 instructions there.
  78
  79 For now, there is no comprehensive documentation of options, but you
  80 can get a pretty good idea by looking at the uct_state_init() function
  81 in uct/uct.c - you will find the list of UCT engine options there, each
  82 with a description. At any rate, usually the three options above are
  83 the only ones you really want to tweak.
  84
  85 Greedy Pachi
  86 ~~~~~~~~~~~~
  87
  88 Normally, Pachi cares only for win or loss and does not take into
  89 account the point amount. This means that it will play slack endgame
  90 when winning and crazy moves followed with a resign when losing.
  91
  92 It may give you a more pleasurable playing experience if Pachi
  93 _does_ take into account the point size, strives for a maximum
  94 (reasonable) win margin when winning and minimal point loss when
  95 losing. This is possible by using the maximize_score parameter, e.g.:
  96
  97         ./pachi -t _1200 threads=8,pondering,maximize_score
  98
  99 This enables an aggressive dynamic komi usage and end result margin
 100 is included in node values aside of winrate. Pachi will also enter
 101 scoring even when losing (normally, Pachi will never pass in that case).
 102 Note that if you pass any 'dynkomi' parameter to Pachi, you will reset
 103 the values set by 'maximize_score'.
 104
 105 Note that Pachi in this mode may be slightly weaker, and result margin
 106 should not be taken into account when judging either player's strength.
 107 During the game, the winning/losing margin can be approximated from
 108 Pachi's "extra komi" or "xkomi" reporting in the progress messages.
 109
 110 Experiments and Testing
 111 ~~~~~~~~~~~~~~~~~~~~~~~
 112
 113 Except UCT, Pachi supports a simple idiotbot-like engine and an example
 114 treeless MonteCarlo-player. The MonteCarlo simulation ("playout")
 115 policies are also pluggable, by default we use the one that makes use of
 116 heavy domain knowledge.
 117
 118 Other special engines are also provided:
 119 * a "distributed" engine for cluster play; the description at the top of
 120   distributed/distributed.c should provide all the guidance
 121 * a simple "replay" engine that will simply play moves according
 122   to the playout policy suggestions
 123 * a simple "patternplay" engine that will play moves according to the
 124   learned patterns
 125 * few other purely for development usage
 126
 127 Pachi can be used as a test opponent for development of other go-playing
 128 programs. For example, to get the "plainest UCT" player, use:
 129
 130         ./pachi -t =5000 policy=ucb1,playout=light,prior=eqex=0,dynkomi=none
 131
 132 This will fix the number of playouts per move to 5000, switch the node
 133 selection policy from ucb1amaf to ucb1 (i.e. disable RAVE), switch the
 134 playouts from heuristic-heavy moggy to uniformly random light, stop
 135 prioring the node values heuristically, and turn off dynamic komi.
 136
 137 You can of course selectively re-enable various features or tweak this
 138 further. But please note that using Pachi in this mode is not tested
 139 extensively, so check its performance in whatever version you test
 140 before you use it as a reference.
 141
 142 Note that even in this "basic UCT" mode, Pachi optimizes tree search
 143 by considering board symmetries at the beginning. Currently, there's no
 144 easy option to turn that off. The easiest way is to tweak board.c so
 145 that board_symmetry_update() has goto break_symmetry at the beginning
 146 and board_clear has board->symmetry.type = SYM_NONE.
 147
 148
 149 Analysis
 150 --------
 151
 152 Pachi can also help you analyze your games by being able to provide
 153 its opinion on various positions. The user interface is very rudimentary,
 154 but the ability is certainly there.
 155
 156 There are currently several Pachi interfaces provided for this purpose.
 157
 158 Winrate Development
 159 ~~~~~~~~~~~~~~~~~~~
 160
 161 Pachi can evaluate all moves within a given game and show how
 162 the winrates for both players evolved - i.e. who was winning at which
 163 game stage. This is implemented using the `tools/sgf-analyse.pl` script.
 164 See the comment on top of the script about its usage.
 165
 166 Move Ranking
 167 ~~~~~~~~~~~~
 168
 169 Pachi can evaluate all available moves in a given situation
 170 and for each give a value between 0 and 1 representing perceived
 171 likelihood of winning the game if one would play that move. I.e. it can
 172 suggest which moves would be good and bad in a single given situation.
 173
 174 To achieve the latter, note the number of move at the situation you
 175 want to evaluate and run the `tools/sgf-ratemove.sh` script.
 176 See the comment on top of the script about its usage.
 177
 178 Pattern Move Hinting
 179 ~~~~~~~~~~~~~~~~~~~~
 180
 181 Pachi can show instantenous pattern-based move suggestions very much
 182 like for example Moyo Go Studio (though of course without a GUI).
 183 You can use the Move Ranking method above (tools/sgf-ratemove.sh),
 184 but pass it an extra parameter '-e patternplay'.
 185
 186
 187 Framework
 188 ---------
 189
 190 The aim of the software framework is to make it easy to plug your
 191 engine to the common infrastructure and implement your ideas while
 192 minimalizing the overhead of implementing the GTP, speed-optimized
 193 board implementation, etc.  Also, there are premade random playout
 194 and UCT tree engines, so that you can directly tweak only particular
 195 policies.  The infrastructure is pretty fast and it should be quite
 196 easy for you (or us) to extend it to provide more facilities for
 197 your engine.
 198
 199 See the HACKING file for a more detailed developer's view of Pachi.
 200
 201 Also, if you are interested about Pachi's architecture, algorithms
 202 etc., consider taking a look at Petr Baudis' Master's Thesis:
 203
 204         http://pasky.or.cz/go/prace.pdf
 205
 206
 207 Licence
 208 -------
 209
 210 Pachi is distributed under the GPLv2 licence (see the COPYING file for
 211 details and full text of the licence); you are welcome to tweak it as
 212 you wish (contributing back upstream is welcome) and distribute
 213 it freely, but only together with the source code. You are welcome
 214 to make private modifications to the code (e.g. try new algorithms and
 215 approaches), use them internally or even to have your bot play on the
 216 internet and enter competitions, but as soon as you want to release it
 217 to the public, you need to release the source code as well.
 218
 219 One exception is the Autotest framework, which is licenced under the
 220 terms of the MIT licence (close to public domain) - you are free to
 221 use it any way you wish.