time_info.byoyomi: Add byoyomi_stones, canadian fields, do not pre-chew byoyomi_time
[pachi/json.git] / uct / uct.c
blobc0d6e7cf5fa4b668b0553c003e6ac392c52971de
1 #include <assert.h>
2 #include <pthread.h>
3 #include <signal.h>
4 #include <stdio.h>
5 #include <stdlib.h>
6 #include <string.h>
7 #include <time.h>
9 #define DEBUG
11 #include "debug.h"
12 #include "board.h"
13 #include "gtp.h"
14 #include "move.h"
15 #include "mq.h"
16 #include "playout.h"
17 #include "playout/elo.h"
18 #include "playout/moggy.h"
19 #include "playout/light.h"
20 #include "random.h"
21 #include "timeinfo.h"
22 #include "tactics.h"
23 #include "uct/internal.h"
24 #include "uct/prior.h"
25 #include "uct/tree.h"
26 #include "uct/uct.h"
27 #include "uct/walk.h"
29 struct uct_policy *policy_ucb1_init(struct uct *u, char *arg);
30 struct uct_policy *policy_ucb1amaf_init(struct uct *u, char *arg);
31 static void uct_pondering_stop(struct uct *u);
34 /* Default number of simulations to perform per move.
35 * Note that this is now in total over all threads! (Unless TM_ROOT.) */
36 #define MC_GAMES 80000
37 #define MC_GAMELEN MAX_GAMELEN
38 static const struct time_info default_ti = {
39 .period = TT_MOVE,
40 .dim = TD_GAMES,
41 .len = { .games = MC_GAMES },
44 /* How big proportion of ownermap counts must be of one color to consider
45 * the point sure. */
46 #define GJ_THRES 0.8
47 /* How many games to consider at minimum before judging groups. */
48 #define GJ_MINGAMES 500
50 /* How often to inspect the tree from the main thread to check for playout
51 * stop, progress reports, etc. (in seconds) */
52 #define TREE_BUSYWAIT_INTERVAL 0.1 /* 100ms */
54 /* Once per how many simulations (per thread) to show a progress report line. */
55 #define TREE_SIMPROGRESS_INTERVAL 10000
58 static void
59 setup_state(struct uct *u, struct board *b, enum stone color)
61 u->t = tree_init(b, color, u->fast_alloc ? u->max_tree_size: 0);
62 if (u->force_seed)
63 fast_srandom(u->force_seed);
64 if (UDEBUGL(0))
65 fprintf(stderr, "Fresh board with random seed %lu\n", fast_getseed());
66 //board_print(b, stderr);
67 if (!u->no_book && b->moves == 0) {
68 assert(color == S_BLACK);
69 tree_load(u->t, b);
73 static void
74 reset_state(struct uct *u)
76 assert(u->t);
77 tree_done(u->t); u->t = NULL;
80 static void
81 prepare_move(struct engine *e, struct board *b, enum stone color)
83 struct uct *u = e->data;
85 if (u->t) {
86 /* Verify that we have sane state. */
87 assert(b->es == u);
88 assert(u->t && b->moves);
89 if (color != stone_other(u->t->root_color)) {
90 fprintf(stderr, "Fatal: Non-alternating play detected %d %d\n",
91 color, u->t->root_color);
92 exit(1);
95 } else {
96 /* We need fresh state. */
97 b->es = u;
98 setup_state(u, b, color);
101 if (u->dynkomi && u->dynkomi > b->moves && (color & u->dynkomi_mask))
102 u->t->extra_komi = uct_get_extra_komi(u, b);
104 u->ownermap.playouts = 0;
105 memset(u->ownermap.map, 0, board_size2(b) * sizeof(u->ownermap.map[0]));
108 static void
109 dead_group_list(struct uct *u, struct board *b, struct move_queue *mq)
111 struct group_judgement gj;
112 gj.thres = GJ_THRES;
113 gj.gs = alloca(board_size2(b) * sizeof(gj.gs[0]));
114 board_ownermap_judge_group(b, &u->ownermap, &gj);
115 groups_of_status(b, &gj, GS_DEAD, mq);
118 bool
119 uct_pass_is_safe(struct uct *u, struct board *b, enum stone color, bool pass_all_alive)
121 if (u->ownermap.playouts < GJ_MINGAMES)
122 return false;
124 struct move_queue mq = { .moves = 0 };
125 if (!pass_all_alive)
126 dead_group_list(u, b, &mq);
127 return pass_is_safe(b, color, &mq);
131 static void
132 uct_printhook_ownermap(struct board *board, coord_t c, FILE *f)
134 struct uct *u = board->es;
135 assert(u);
136 const char chr[] = ":XO,"; // dame, black, white, unclear
137 const char chm[] = ":xo,";
138 char ch = chr[board_ownermap_judge_point(&u->ownermap, c, GJ_THRES)];
139 if (ch == ',') { // less precise estimate then?
140 ch = chm[board_ownermap_judge_point(&u->ownermap, c, 0.67)];
142 fprintf(f, "%c ", ch);
145 static char *
146 uct_notify_play(struct engine *e, struct board *b, struct move *m)
148 struct uct *u = e->data;
149 if (!u->t) {
150 /* No state, create one - this is probably game beginning
151 * and we need to load the opening book right now. */
152 prepare_move(e, b, m->color);
153 assert(u->t);
156 /* Stop pondering. */
157 /* XXX: If we are about to receive multiple 'play' commands,
158 * e.g. in a rengo, we will not ponder during the rest of them. */
159 uct_pondering_stop(u);
161 if (is_resign(m->coord)) {
162 /* Reset state. */
163 reset_state(u);
164 return NULL;
167 /* Promote node of the appropriate move to the tree root. */
168 assert(u->t->root);
169 if (!tree_promote_at(u->t, b, m->coord)) {
170 if (UDEBUGL(0))
171 fprintf(stderr, "Warning: Cannot promote move node! Several play commands in row?\n");
172 reset_state(u);
173 return NULL;
176 return NULL;
179 static char *
180 uct_chat(struct engine *e, struct board *b, char *cmd)
182 struct uct *u = e->data;
183 static char reply[1024];
185 cmd += strspn(cmd, " \n\t");
186 if (!strncasecmp(cmd, "winrate", 7)) {
187 if (!u->t)
188 return "no game context (yet?)";
189 enum stone color = u->t->root_color;
190 struct tree_node *n = u->t->root;
191 snprintf(reply, 1024, "In %d playouts at %d threads, %s %s can win with %.2f%% probability",
192 n->u.playouts, u->threads, stone2str(color), coord2sstr(n->coord, b),
193 tree_node_get_value(u->t, -1, n->u.value) * 100);
194 if (abs(u->t->extra_komi) >= 0.5) {
195 sprintf(reply + strlen(reply), ", while self-imposing extra komi %.1f",
196 u->t->extra_komi);
198 strcat(reply, ".");
199 return reply;
201 return NULL;
204 static void
205 uct_dead_group_list(struct engine *e, struct board *b, struct move_queue *mq)
207 struct uct *u = e->data;
209 /* This means the game is probably over, no use pondering on. */
210 uct_pondering_stop(u);
212 if (u->pass_all_alive)
213 return; // no dead groups
215 bool mock_state = false;
217 if (!u->t) {
218 /* No state, but we cannot just back out - we might
219 * have passed earlier, only assuming some stones are
220 * dead, and then re-connected, only to lose counting
221 * when all stones are assumed alive. */
222 /* Mock up some state and seed the ownermap by few
223 * simulations. */
224 prepare_move(e, b, S_BLACK); assert(u->t);
225 for (int i = 0; i < GJ_MINGAMES; i++)
226 uct_playout(u, b, S_BLACK, u->t);
227 mock_state = true;
230 dead_group_list(u, b, mq);
232 if (mock_state) {
233 /* Clean up the mock state in case we will receive
234 * a genmove; we could get a non-alternating-move
235 * error from prepare_move() in that case otherwise. */
236 reset_state(u);
240 static void
241 playout_policy_done(struct playout_policy *p)
243 if (p->done) p->done(p);
244 if (p->data) free(p->data);
245 free(p);
248 static void
249 uct_done(struct engine *e)
251 /* This is called on engine reset, especially when clear_board
252 * is received and new game should begin. */
253 struct uct *u = e->data;
254 uct_pondering_stop(u);
255 if (u->t) reset_state(u);
256 free(u->ownermap.map);
258 free(u->policy);
259 free(u->random_policy);
260 playout_policy_done(u->playout);
261 uct_prior_done(u->prior);
265 /* Pachi threading structure (if uct_playouts_parallel() is used):
267 * main thread
268 * | main(), GTP communication, ...
269 * | starts and stops the search managed by thread_manager
271 * thread_manager
272 * | spawns and collects worker threads
274 * worker0
275 * worker1
276 * ...
277 * workerK
278 * uct_playouts() loop, doing descend-playout until uct_halt
280 * Another way to look at it is by functions (lines denote thread boundaries):
282 * | uct_genmove()
283 * | uct_search() (uct_search_start() .. uct_search_stop())
284 * | -----------------------
285 * | spawn_thread_manager()
286 * | -----------------------
287 * | spawn_worker()
288 * V uct_playouts() */
290 /* Set in thread manager in case the workers should stop. */
291 volatile sig_atomic_t uct_halt = 0;
292 /* ID of the running worker thread. */
293 __thread int thread_id = -1;
294 /* ID of the thread manager. */
295 static pthread_t thread_manager;
296 static bool thread_manager_running;
298 static pthread_mutex_t finish_mutex = PTHREAD_MUTEX_INITIALIZER;
299 static pthread_cond_t finish_cond = PTHREAD_COND_INITIALIZER;
300 static volatile int finish_thread;
301 static pthread_mutex_t finish_serializer = PTHREAD_MUTEX_INITIALIZER;
303 struct spawn_ctx {
304 int tid;
305 struct uct *u;
306 struct board *b;
307 enum stone color;
308 struct tree *t;
309 unsigned long seed;
310 int games;
313 static void *
314 spawn_worker(void *ctx_)
316 struct spawn_ctx *ctx = ctx_;
317 /* Setup */
318 fast_srandom(ctx->seed);
319 thread_id = ctx->tid;
320 /* Run */
321 ctx->games = uct_playouts(ctx->u, ctx->b, ctx->color, ctx->t);
322 /* Finish */
323 pthread_mutex_lock(&finish_serializer);
324 pthread_mutex_lock(&finish_mutex);
325 finish_thread = ctx->tid;
326 pthread_cond_signal(&finish_cond);
327 pthread_mutex_unlock(&finish_mutex);
328 return ctx;
331 /* Thread manager, controlling worker threads. It must be called with
332 * finish_mutex lock held, but it will unlock it itself before exiting;
333 * this is necessary to be completely deadlock-free. */
334 /* The finish_cond can be signalled for it to stop; in that case,
335 * the caller should set finish_thread = -1. */
336 /* After it is started, it will update mctx->t to point at some tree
337 * used for the actual search (matters only for TM_ROOT), on return
338 * it will set mctx->games to the number of performed simulations. */
339 static void *
340 spawn_thread_manager(void *ctx_)
342 /* In thread_manager, we use only some of the ctx fields. */
343 struct spawn_ctx *mctx = ctx_;
344 struct uct *u = mctx->u;
345 struct tree *t = mctx->t;
346 bool shared_tree = u->parallel_tree;
347 fast_srandom(mctx->seed);
349 int played_games = 0;
350 pthread_t threads[u->threads];
351 int joined = 0;
353 uct_halt = 0;
355 /* Spawn threads... */
356 for (int ti = 0; ti < u->threads; ti++) {
357 struct spawn_ctx *ctx = malloc(sizeof(*ctx));
358 ctx->u = u; ctx->b = mctx->b; ctx->color = mctx->color;
359 mctx->t = ctx->t = shared_tree ? t : tree_copy(t);
360 ctx->tid = ti; ctx->seed = fast_random(65536) + ti;
361 pthread_create(&threads[ti], NULL, spawn_worker, ctx);
362 if (UDEBUGL(2))
363 fprintf(stderr, "Spawned worker %d\n", ti);
366 /* ...and collect them back: */
367 while (joined < u->threads) {
368 /* Wait for some thread to finish... */
369 pthread_cond_wait(&finish_cond, &finish_mutex);
370 if (finish_thread < 0) {
371 /* Stop-by-caller. Tell the workers to wrap up. */
372 uct_halt = 1;
373 continue;
375 /* ...and gather its remnants. */
376 struct spawn_ctx *ctx;
377 pthread_join(threads[finish_thread], (void **) &ctx);
378 played_games += ctx->games;
379 joined++;
380 if (!shared_tree) {
381 if (ctx->t == mctx->t) mctx->t = t;
382 tree_merge(t, ctx->t);
383 tree_done(ctx->t);
385 free(ctx);
386 if (UDEBUGL(2))
387 fprintf(stderr, "Joined worker %d\n", finish_thread);
388 pthread_mutex_unlock(&finish_serializer);
391 pthread_mutex_unlock(&finish_mutex);
393 if (!shared_tree)
394 tree_normalize(mctx->t, u->threads);
396 mctx->games = played_games;
397 return mctx;
400 static struct spawn_ctx *
401 uct_search_start(struct uct *u, struct board *b, enum stone color, struct tree *t)
403 assert(u->threads > 0);
404 assert(!thread_manager_running);
406 struct spawn_ctx ctx = { .u = u, .b = b, .color = color, .t = t, .seed = fast_random(65536) };
407 static struct spawn_ctx mctx; mctx = ctx;
408 pthread_mutex_lock(&finish_mutex);
409 pthread_create(&thread_manager, NULL, spawn_thread_manager, &mctx);
410 thread_manager_running = true;
411 return &mctx;
414 static struct spawn_ctx *
415 uct_search_stop(void)
417 assert(thread_manager_running);
419 /* Signal thread manager to stop the workers. */
420 pthread_mutex_lock(&finish_mutex);
421 finish_thread = -1;
422 pthread_cond_signal(&finish_cond);
423 pthread_mutex_unlock(&finish_mutex);
425 /* Collect the thread manager. */
426 struct spawn_ctx *pctx;
427 thread_manager_running = false;
428 pthread_join(thread_manager, (void **) &pctx);
429 return pctx;
433 /* Run time-limited MCTS search on foreground. */
434 static int
435 uct_search(struct uct *u, struct board *b, struct time_info *ti, enum stone color, struct tree *t)
437 if (UDEBUGL(2) && u->t->root->u.playouts > 0)
438 fprintf(stderr, "<pre-simulated %d games skipped>\n", u->t->root->u.playouts);
440 /* Set up time conditions. */
441 if (ti->period == TT_NULL) *ti = default_ti;
442 struct time_stop stop;
443 time_stop_conditions(ti, b, u->fuseki_end, u->yose_start, &stop);
445 /* Number of last game with progress print. */
446 int last_print = t->root->u.playouts;
447 /* Number of simulations to wait before next print. */
448 int print_interval = TREE_SIMPROGRESS_INTERVAL * (u->thread_model == TM_ROOT ? 1 : u->threads);
449 /* Printed notification about full memory? */
450 bool print_fullmem = false;
452 struct spawn_ctx *ctx = uct_search_start(u, b, color, t);
454 /* The search tree is ctx->t. This is normally == t, but in case of
455 * TM_ROOT, it is one of the trees belonging to the independent
456 * workers. It is important to reference ctx->t directly since the
457 * thread manager will swap the tree pointer asynchronously. */
458 /* XXX: This means TM_ROOT support is suboptimal since single stalled
459 * thread can stall the others in case of limiting the search by game
460 * count. However, TM_ROOT just does not deserve any more extra code
461 * right now. */
463 struct tree_node *best = NULL, *prev_best;
464 struct tree_node *winner = NULL, *prev_winner;
466 double busywait_interval = TREE_BUSYWAIT_INTERVAL;
468 /* Now, just periodically poll the search tree. */
469 while (1) {
470 time_sleep(busywait_interval);
471 /* busywait_interval should never be less than desired time, or the
472 * time control is broken. But if it happens to be less, we still search
473 * at least 100ms otherwise the move is completely random. */
475 int i = ctx->t->root->u.playouts;
477 /* Print progress? */
478 if (i - last_print > print_interval) {
479 last_print += print_interval; // keep the numbers tidy
480 uct_progress_status(u, ctx->t, color, last_print);
482 if (!print_fullmem && ctx->t->nodes_size > u->max_tree_size) {
483 if (UDEBUGL(2))
484 fprintf(stderr, "memory limit hit (%ld > %lu)\n", ctx->t->nodes_size, u->max_tree_size);
485 print_fullmem = true;
488 /* Check against time settings. */
489 bool desired_done = false;
490 if (ti->dim == TD_WALLTIME) {
491 double now = time_now();
492 if (now > stop.worst.time) break;
493 desired_done = now > stop.desired.time;
494 } else {
495 assert(ti->dim == TD_GAMES);
496 if (i > stop.worst.playouts) break;
497 desired_done = i > stop.desired.playouts;
500 /* Early break in won situation. */
501 prev_best = best;
502 best = u->policy->choose(u->policy, ctx->t->root, b, color);
503 if (best && ((best->u.playouts >= 2000 && tree_node_get_value(ctx->t, 1, best->u.value) >= u->loss_threshold)
504 || (best->u.playouts >= 500 && tree_node_get_value(ctx->t, 1, best->u.value) >= 0.95)))
505 break;
507 if (desired_done) {
508 if (!u->policy->winner || !u->policy->evaluate)
509 break;
510 /* Stop only if best explored has also highest value: */
511 prev_winner = winner;
512 winner = u->policy->winner(u->policy, ctx->t, ctx->t->root);
513 if (best && best == winner)
514 break;
515 if (UDEBUGL(3) && (best != prev_best || winner != prev_winner)) {
516 fprintf(stderr, "[%d] best", i);
517 if (best)
518 fprintf(stderr, " %3s [%d] %f", coord2sstr(best->coord, ctx->t->board),
519 best->u.playouts, tree_node_get_value(ctx->t, 1, best->u.value));
520 fprintf(stderr, " != winner");
521 if (winner)
522 fprintf(stderr, " %3s [%d] %f ", coord2sstr(winner->coord, ctx->t->board),
523 winner->u.playouts, tree_node_get_value(ctx->t, 1, winner->u.value));
524 fprintf(stderr, "\n");
528 /* TODO: Early break if best->variance goes under threshold and we already
529 * have enough playouts (possibly thanks to book or to pondering). */
530 /* TODO: Early break if second best has no chance to catch up. */
533 ctx = uct_search_stop();
535 if (UDEBUGL(2))
536 tree_dump(t, u->dumpthres);
537 if (UDEBUGL(0))
538 uct_progress_status(u, t, color, ctx->games);
540 return ctx->games;
544 /* Start pondering background with @color to play. */
545 static void
546 uct_pondering_start(struct uct *u, struct board *b0, struct tree *t, enum stone color)
548 if (UDEBUGL(1))
549 fprintf(stderr, "Starting to ponder with color %s\n", stone2str(stone_other(color)));
550 u->pondering = true;
552 /* We need a local board copy to ponder upon. */
553 struct board *b = malloc(sizeof(*b)); board_copy(b, b0);
555 /* *b0 did not have the genmove'd move played yet. */
556 struct move m = { t->root->coord, t->root_color };
557 int res = board_play(b, &m);
558 assert(res >= 0);
560 /* Start MCTS manager thread "headless". */
561 uct_search_start(u, b, color, t);
564 /* uct_search_stop() frontend for the pondering (non-genmove) mode. */
565 static void
566 uct_pondering_stop(struct uct *u)
568 u->pondering = false;
569 if (!thread_manager_running)
570 return;
572 /* Stop the thread manager. */
573 struct spawn_ctx *ctx = uct_search_stop();
574 if (UDEBUGL(1)) {
575 fprintf(stderr, "(pondering) ");
576 uct_progress_status(u, ctx->t, ctx->color, ctx->games);
578 free(ctx->b);
582 static coord_t *
583 uct_genmove(struct engine *e, struct board *b, struct time_info *ti, enum stone color, bool pass_all_alive)
585 double start_time = time_now();
586 struct uct *u = e->data;
588 if (b->superko_violation) {
589 fprintf(stderr, "!!! WARNING: SUPERKO VIOLATION OCCURED BEFORE THIS MOVE\n");
590 fprintf(stderr, "Maybe you play with situational instead of positional superko?\n");
591 fprintf(stderr, "I'm going to ignore the violation, but note that I may miss\n");
592 fprintf(stderr, "some moves valid under this ruleset because of this.\n");
593 b->superko_violation = false;
596 /* Seed the tree. */
597 uct_pondering_stop(u);
598 prepare_move(e, b, color);
599 assert(u->t);
601 /* Perform the Monte Carlo Tree Search! */
602 int played_games = uct_search(u, b, ti, color, u->t);
604 /* Choose the best move from the tree. */
605 struct tree_node *best = u->policy->choose(u->policy, u->t->root, b, color);
606 if (!best) {
607 reset_state(u);
608 return coord_copy(pass);
610 if (UDEBUGL(1))
611 fprintf(stderr, "*** WINNER is %s (%d,%d) with score %1.4f (%d/%d:%d games)\n",
612 coord2sstr(best->coord, b), coord_x(best->coord, b), coord_y(best->coord, b),
613 tree_node_get_value(u->t, 1, best->u.value),
614 best->u.playouts, u->t->root->u.playouts, played_games);
616 /* Do not resign if we're so short of time that evaluation of best move is completely
617 * unreliable, we might be winning actually. In this case best is almost random but
618 * still better than resign. */
619 if (tree_node_get_value(u->t, 1, best->u.value) < u->resign_ratio && !is_pass(best->coord)
620 && best->u.playouts > GJ_MINGAMES) {
621 reset_state(u);
622 return coord_copy(resign);
625 /* If the opponent just passed and we win counting, always
626 * pass as well. */
627 if (b->moves > 1 && is_pass(b->last_move.coord)) {
628 /* Make sure enough playouts are simulated. */
629 while (u->ownermap.playouts < GJ_MINGAMES)
630 uct_playout(u, b, color, u->t);
631 if (uct_pass_is_safe(u, b, color, u->pass_all_alive || pass_all_alive)) {
632 if (UDEBUGL(0))
633 fprintf(stderr, "<Will rather pass, looks safe enough.>\n");
634 best->coord = pass;
638 tree_promote_node(u->t, &best);
639 /* After a pass, pondering is harmful for two reasons:
640 * (i) We might keep pondering even when the game is over.
641 * Of course this is the case for opponent resign as well.
642 * (ii) More importantly, the ownermap will get skewed since
643 * the UCT will start cutting off any playouts. */
644 if (u->pondering_opt && !is_pass(best->coord)) {
645 uct_pondering_start(u, b, u->t, stone_other(color));
647 if (UDEBUGL(2)) {
648 double time = time_now() - start_time + 0.000001; /* avoid divide by zero */
649 fprintf(stderr, "genmove in %0.2fs (%d games/s, %d games/s/thread)\n",
650 time, (int)(played_games/time), (int)(played_games/time/u->threads));
652 return coord_copy(best->coord);
656 bool
657 uct_genbook(struct engine *e, struct board *b, struct time_info *ti, enum stone color)
659 struct uct *u = e->data;
660 if (!u->t) prepare_move(e, b, color);
661 assert(u->t);
663 if (ti->dim == TD_GAMES) {
664 /* Don't count in games that already went into the book. */
665 ti->len.games += u->t->root->u.playouts;
667 uct_search(u, b, ti, color, u->t);
669 assert(ti->dim == TD_GAMES);
670 tree_save(u->t, b, ti->len.games / 100);
672 return true;
675 void
676 uct_dumpbook(struct engine *e, struct board *b, enum stone color)
678 struct uct *u = e->data;
679 struct tree *t = tree_init(b, color, u->fast_alloc ? u->max_tree_size: 0);
680 tree_load(t, b);
681 tree_dump(t, 0);
682 tree_done(t);
686 struct uct *
687 uct_state_init(char *arg, struct board *b)
689 struct uct *u = calloc(1, sizeof(struct uct));
691 u->debug_level = 3;
692 u->gamelen = MC_GAMELEN;
693 u->mercymin = 0;
694 u->expand_p = 2;
695 u->dumpthres = 1000;
696 u->playout_amaf = true;
697 u->playout_amaf_nakade = false;
698 u->amaf_prior = false;
699 u->max_tree_size = 3072ULL * 1048576;
701 if (board_size(b) - 2 >= 19)
702 u->dynkomi = 200;
703 u->dynkomi_mask = S_BLACK;
705 u->threads = 1;
706 u->thread_model = TM_TREEVL;
707 u->parallel_tree = true;
708 u->virtual_loss = true;
709 u->fuseki_end = 20; // max time at 361*20% = 72 moves (our 36th move, still 99 to play)
710 u->yose_start = 40; // (100-40-25)*361/100/2 = 63 moves still to play by us then
712 u->val_scale = 0.04; u->val_points = 40;
714 if (arg) {
715 char *optspec, *next = arg;
716 while (*next) {
717 optspec = next;
718 next += strcspn(next, ",");
719 if (*next) { *next++ = 0; } else { *next = 0; }
721 char *optname = optspec;
722 char *optval = strchr(optspec, '=');
723 if (optval) *optval++ = 0;
725 if (!strcasecmp(optname, "debug")) {
726 if (optval)
727 u->debug_level = atoi(optval);
728 else
729 u->debug_level++;
730 } else if (!strcasecmp(optname, "mercy") && optval) {
731 /* Minimal difference of black/white captures
732 * to stop playout - "Mercy Rule". Speeds up
733 * hopeless playouts at the expense of some
734 * accuracy. */
735 u->mercymin = atoi(optval);
736 } else if (!strcasecmp(optname, "gamelen") && optval) {
737 u->gamelen = atoi(optval);
738 } else if (!strcasecmp(optname, "expand_p") && optval) {
739 u->expand_p = atoi(optval);
740 } else if (!strcasecmp(optname, "dumpthres") && optval) {
741 u->dumpthres = atoi(optval);
742 } else if (!strcasecmp(optname, "playout_amaf")) {
743 /* Whether to include random playout moves in
744 * AMAF as well. (Otherwise, only tree moves
745 * are included in AMAF. Of course makes sense
746 * only in connection with an AMAF policy.) */
747 /* with-without: 55.5% (+-4.1) */
748 if (optval && *optval == '0')
749 u->playout_amaf = false;
750 else
751 u->playout_amaf = true;
752 } else if (!strcasecmp(optname, "playout_amaf_nakade")) {
753 /* Whether to include nakade moves from playouts
754 * in the AMAF statistics; this tends to nullify
755 * the playout_amaf effect by adding too much
756 * noise. */
757 if (optval && *optval == '0')
758 u->playout_amaf_nakade = false;
759 else
760 u->playout_amaf_nakade = true;
761 } else if (!strcasecmp(optname, "playout_amaf_cutoff") && optval) {
762 /* Keep only first N% of playout stage AMAF
763 * information. */
764 u->playout_amaf_cutoff = atoi(optval);
765 } else if ((!strcasecmp(optname, "policy") || !strcasecmp(optname, "random_policy")) && optval) {
766 char *policyarg = strchr(optval, ':');
767 struct uct_policy **p = !strcasecmp(optname, "policy") ? &u->policy : &u->random_policy;
768 if (policyarg)
769 *policyarg++ = 0;
770 if (!strcasecmp(optval, "ucb1")) {
771 *p = policy_ucb1_init(u, policyarg);
772 } else if (!strcasecmp(optval, "ucb1amaf")) {
773 *p = policy_ucb1amaf_init(u, policyarg);
774 } else {
775 fprintf(stderr, "UCT: Invalid tree policy %s\n", optval);
776 exit(1);
778 } else if (!strcasecmp(optname, "playout") && optval) {
779 char *playoutarg = strchr(optval, ':');
780 if (playoutarg)
781 *playoutarg++ = 0;
782 if (!strcasecmp(optval, "moggy")) {
783 u->playout = playout_moggy_init(playoutarg);
784 } else if (!strcasecmp(optval, "light")) {
785 u->playout = playout_light_init(playoutarg);
786 } else if (!strcasecmp(optval, "elo")) {
787 u->playout = playout_elo_init(playoutarg);
788 } else {
789 fprintf(stderr, "UCT: Invalid playout policy %s\n", optval);
790 exit(1);
792 } else if (!strcasecmp(optname, "prior") && optval) {
793 u->prior = uct_prior_init(optval, b);
794 } else if (!strcasecmp(optname, "amaf_prior") && optval) {
795 u->amaf_prior = atoi(optval);
796 } else if (!strcasecmp(optname, "threads") && optval) {
797 /* By default, Pachi will run with only single
798 * tree search thread! */
799 u->threads = atoi(optval);
800 } else if (!strcasecmp(optname, "thread_model") && optval) {
801 if (!strcasecmp(optval, "root")) {
802 /* Root parallelization - each thread
803 * does independent search, trees are
804 * merged at the end. */
805 u->thread_model = TM_ROOT;
806 u->parallel_tree = false;
807 u->virtual_loss = false;
808 } else if (!strcasecmp(optval, "tree")) {
809 /* Tree parallelization - all threads
810 * grind on the same tree. */
811 u->thread_model = TM_TREE;
812 u->parallel_tree = true;
813 u->virtual_loss = false;
814 } else if (!strcasecmp(optval, "treevl")) {
815 /* Tree parallelization, but also
816 * with virtual losses - this discou-
817 * rages most threads choosing the
818 * same tree branches to read. */
819 u->thread_model = TM_TREEVL;
820 u->parallel_tree = true;
821 u->virtual_loss = true;
822 } else {
823 fprintf(stderr, "UCT: Invalid thread model %s\n", optval);
824 exit(1);
826 } else if (!strcasecmp(optname, "pondering")) {
827 /* Keep searching even during opponent's turn. */
828 u->pondering_opt = !optval || atoi(optval);
829 } else if (!strcasecmp(optname, "fuseki_end") && optval) {
830 /* At the very beginning it's not worth thinking
831 * too long because the playout evaluations are
832 * very noisy. So gradually increase the thinking
833 * time up to maximum when fuseki_end percent
834 * of the board has been played.
835 * This only applies if we are not in byoyomi. */
836 u->fuseki_end = atoi(optval);
837 } else if (!strcasecmp(optname, "yose_start") && optval) {
838 /* When yose_start percent of the board has been
839 * played, or if we are in byoyomi, stop spending
840 * more time and spread the remaining time
841 * uniformly.
842 * Between fuseki_end and yose_start, we spend
843 * a constant proportion of the remaining time
844 * on each move. (yose_start should actually
845 * be much earlier than when real yose start,
846 * but "yose" is a good short name to convey
847 * the idea.) */
848 u->yose_start = atoi(optval);
849 } else if (!strcasecmp(optname, "force_seed") && optval) {
850 u->force_seed = atoi(optval);
851 } else if (!strcasecmp(optname, "no_book")) {
852 u->no_book = true;
853 } else if (!strcasecmp(optname, "dynkomi")) {
854 /* Dynamic komi in handicap game; linearly
855 * decreases to basic settings until move
856 * #optval. */
857 u->dynkomi = optval ? atoi(optval) : 150;
858 } else if (!strcasecmp(optname, "dynkomi_mask") && optval) {
859 /* Bitmask of colors the player must be
860 * for dynkomi be applied; you may want
861 * to use dynkomi_mask=3 to allow dynkomi
862 * even in games where Pachi is white. */
863 u->dynkomi_mask = atoi(optval);
864 } else if (!strcasecmp(optname, "val_scale") && optval) {
865 /* How much of the game result value should be
866 * influenced by win size. Zero means it isn't. */
867 u->val_scale = atof(optval);
868 } else if (!strcasecmp(optname, "val_points") && optval) {
869 /* Maximum size of win to be scaled into game
870 * result value. Zero means boardsize^2. */
871 u->val_points = atoi(optval) * 2; // result values are doubled
872 } else if (!strcasecmp(optname, "val_extra")) {
873 /* If false, the score coefficient will be simply
874 * added to the value, instead of scaling the result
875 * coefficient because of it. */
876 u->val_extra = !optval || atoi(optval);
877 } else if (!strcasecmp(optname, "root_heuristic") && optval) {
878 /* Whether to bias exploration by root node values
879 * (must be supported by the used policy).
880 * 0: Don't.
881 * 1: Do, value = result.
882 * Try to temper the result:
883 * 2: Do, value = 0.5+(result-expected)/2.
884 * 3: Do, value = 0.5+bzz((result-expected)^2). */
885 u->root_heuristic = atoi(optval);
886 } else if (!strcasecmp(optname, "pass_all_alive")) {
887 /* Whether to consider all stones alive at the game
888 * end instead of marking dead groupd. */
889 u->pass_all_alive = !optval || atoi(optval);
890 } else if (!strcasecmp(optname, "random_policy_chance") && optval) {
891 /* If specified (N), with probability 1/N, random_policy policy
892 * descend is used instead of main policy descend; useful
893 * if specified policy (e.g. UCB1AMAF) can make unduly biased
894 * choices sometimes, you can fall back to e.g.
895 * random_policy=UCB1. */
896 u->random_policy_chance = atoi(optval);
897 } else if (!strcasecmp(optname, "max_tree_size") && optval) {
898 /* Maximum amount of memory [MiB] consumed by the move tree.
899 * Default is 3072 (3 GiB). Note that if you use TM_ROOT,
900 * this limits size of only one of the trees, not all of them
901 * together. */
902 u->max_tree_size = atol(optval) * 1048576;
903 } else if (!strcasecmp(optname, "banner") && optval) {
904 /* Additional banner string. This must come as the
905 * last engine parameter. */
906 if (*next) *--next = ',';
907 u->banner = strdup(optval);
908 break;
909 } else {
910 fprintf(stderr, "uct: Invalid engine argument %s or missing value\n", optname);
911 exit(1);
916 u->resign_ratio = 0.2; /* Resign when most games are lost. */
917 u->loss_threshold = 0.85; /* Stop reading if after at least 5000 playouts this is best value. */
918 if (!u->policy)
919 u->policy = policy_ucb1amaf_init(u, NULL);
921 if (!!u->random_policy_chance ^ !!u->random_policy) {
922 fprintf(stderr, "uct: Only one of random_policy and random_policy_chance is set\n");
923 exit(1);
926 if (u->fast_alloc && !u->parallel_tree) {
927 fprintf(stderr, "fast_alloc not supported with root parallelization.\n");
928 exit(1);
931 if (!u->prior)
932 u->prior = uct_prior_init(NULL, b);
934 if (!u->playout)
935 u->playout = playout_moggy_init(NULL);
936 u->playout->debug_level = u->debug_level;
938 u->ownermap.map = malloc(board_size2(b) * sizeof(u->ownermap.map[0]));
940 /* Some things remain uninitialized for now - the opening book
941 * is not loaded and the tree not set up. */
942 /* This will be initialized in setup_state() at the first move
943 * received/requested. This is because right now we are not aware
944 * about any komi or handicap setup and such. */
946 return u;
949 struct engine *
950 engine_uct_init(char *arg, struct board *b)
952 struct uct *u = uct_state_init(arg, b);
953 struct engine *e = calloc(1, sizeof(struct engine));
954 e->name = "UCT Engine";
955 e->printhook = uct_printhook_ownermap;
956 e->notify_play = uct_notify_play;
957 e->chat = uct_chat;
958 e->genmove = uct_genmove;
959 e->dead_group_list = uct_dead_group_list;
960 e->done = uct_done;
961 e->data = u;
963 const char banner[] = "I'm playing UCT. When I'm losing, I will resign, "
964 "if I think I win, I play until you pass. "
965 "Anyone can send me 'winrate' in private chat to get my assessment of the position.";
966 if (!u->banner) u->banner = "";
967 e->comment = malloc(sizeof(banner) + strlen(u->banner) + 1);
968 sprintf(e->comment, "%s %s", banner, u->banner);
970 return e;