GTP uct_evaluate: Add a hacker-friendly description
[pachi/derm.git] / uct / uct.c
blob3aa2fdb65f6fd620f97c4a6b7d1fc50555d0d216
1 #include <assert.h>
2 #include <math.h>
3 #include <stdio.h>
4 #include <stdlib.h>
5 #include <string.h>
6 #include <time.h>
8 #define DEBUG
10 #include "debug.h"
11 #include "board.h"
12 #include "gtp.h"
13 #include "move.h"
14 #include "mq.h"
15 #include "joseki/base.h"
16 #include "playout.h"
17 #include "playout/elo.h"
18 #include "playout/moggy.h"
19 #include "playout/light.h"
20 #include "tactics/util.h"
21 #include "timeinfo.h"
22 #include "uct/dynkomi.h"
23 #include "uct/internal.h"
24 #include "uct/plugins.h"
25 #include "uct/prior.h"
26 #include "uct/search.h"
27 #include "uct/slave.h"
28 #include "uct/tree.h"
29 #include "uct/uct.h"
30 #include "uct/walk.h"
32 struct uct_policy *policy_ucb1_init(struct uct *u, char *arg);
33 struct uct_policy *policy_ucb1amaf_init(struct uct *u, char *arg);
34 static void uct_pondering_start(struct uct *u, struct board *b0, struct tree *t, enum stone color);
36 /* Maximal simulation length. */
37 #define MC_GAMELEN MAX_GAMELEN
40 static void
41 setup_state(struct uct *u, struct board *b, enum stone color)
43 u->t = tree_init(b, color, u->fast_alloc ? u->max_tree_size : 0,
44 u->max_pruned_size, u->pruning_threshold, u->local_tree_aging, u->stats_hbits);
45 if (u->force_seed)
46 fast_srandom(u->force_seed);
47 if (UDEBUGL(0))
48 fprintf(stderr, "Fresh board with random seed %lu\n", fast_getseed());
49 //board_print(b, stderr);
50 if (!u->no_book && b->moves == 0) {
51 assert(color == S_BLACK);
52 tree_load(u->t, b);
56 static void
57 reset_state(struct uct *u)
59 assert(u->t);
60 tree_done(u->t); u->t = NULL;
63 static void
64 setup_dynkomi(struct uct *u, struct board *b, enum stone to_play)
66 if (u->t->use_extra_komi && !u->pondering && u->dynkomi->permove)
67 u->t->extra_komi = u->dynkomi->permove(u->dynkomi, b, u->t);
68 else if (!u->t->use_extra_komi)
69 u->t->extra_komi = 0;
72 void
73 uct_prepare_move(struct uct *u, struct board *b, enum stone color)
75 if (u->t) {
76 /* Verify that we have sane state. */
77 assert(b->es == u);
78 assert(u->t && b->moves);
79 if (color != stone_other(u->t->root_color)) {
80 fprintf(stderr, "Fatal: Non-alternating play detected %d %d\n",
81 color, u->t->root_color);
82 exit(1);
84 uct_htable_reset(u->t);
86 } else {
87 /* We need fresh state. */
88 b->es = u;
89 setup_state(u, b, color);
92 u->ownermap.playouts = 0;
93 memset(u->ownermap.map, 0, board_size2(b) * sizeof(u->ownermap.map[0]));
94 u->played_own = u->played_all = 0;
97 static void
98 dead_group_list(struct uct *u, struct board *b, struct move_queue *mq)
100 struct group_judgement gj;
101 gj.thres = GJ_THRES;
102 gj.gs = alloca(board_size2(b) * sizeof(gj.gs[0]));
103 board_ownermap_judge_group(b, &u->ownermap, &gj);
104 groups_of_status(b, &gj, GS_DEAD, mq);
107 bool
108 uct_pass_is_safe(struct uct *u, struct board *b, enum stone color, bool pass_all_alive)
110 if (u->ownermap.playouts < GJ_MINGAMES)
111 return false;
113 struct move_queue mq = { .moves = 0 };
114 dead_group_list(u, b, &mq);
115 if (pass_all_alive && mq.moves > 0)
116 return false; // We need to remove some dead groups first.
117 return pass_is_safe(b, color, &mq);
120 static char *
121 uct_printhook_ownermap(struct board *board, coord_t c, char *s, char *end)
123 struct uct *u = board->es;
124 assert(u);
125 const char chr[] = ":XO,"; // dame, black, white, unclear
126 const char chm[] = ":xo,";
127 char ch = chr[board_ownermap_judge_point(&u->ownermap, c, GJ_THRES)];
128 if (ch == ',') { // less precise estimate then?
129 ch = chm[board_ownermap_judge_point(&u->ownermap, c, 0.67)];
131 s += snprintf(s, end - s, "%c ", ch);
132 return s;
135 static char *
136 uct_notify_play(struct engine *e, struct board *b, struct move *m)
138 struct uct *u = e->data;
139 if (!u->t) {
140 /* No state, create one - this is probably game beginning
141 * and we need to load the opening book right now. */
142 uct_prepare_move(u, b, m->color);
143 assert(u->t);
146 /* Stop pondering, required by tree_promote_at() */
147 uct_pondering_stop(u);
148 if (UDEBUGL(2) && u->slave)
149 tree_dump(u->t, u->dumpthres);
151 if (is_resign(m->coord)) {
152 /* Reset state. */
153 reset_state(u);
154 return NULL;
157 /* Promote node of the appropriate move to the tree root. */
158 assert(u->t->root);
159 if (!tree_promote_at(u->t, b, m->coord)) {
160 if (UDEBUGL(0))
161 fprintf(stderr, "Warning: Cannot promote move node! Several play commands in row?\n");
162 reset_state(u);
163 return NULL;
166 /* If we are a slave in a distributed engine, start pondering once
167 * we know which move we actually played. See uct_genmove() about
168 * the check for pass. */
169 if (u->pondering_opt && u->slave && m->color == u->my_color && !is_pass(m->coord))
170 uct_pondering_start(u, b, u->t, stone_other(m->color));
172 return NULL;
175 static char *
176 uct_result(struct engine *e, struct board *b)
178 struct uct *u = e->data;
179 static char reply[1024];
181 if (!u->t)
182 return NULL;
183 enum stone color = u->t->root_color;
184 struct tree_node *n = u->t->root;
185 snprintf(reply, 1024, "%s %s %d %.2f %.1f",
186 stone2str(color), coord2sstr(n->coord, b),
187 n->u.playouts, tree_node_get_value(u->t, -1, n->u.value),
188 u->t->use_extra_komi ? u->t->extra_komi : 0);
189 return reply;
192 static char *
193 uct_chat(struct engine *e, struct board *b, char *cmd)
195 struct uct *u = e->data;
196 static char reply[1024];
198 cmd += strspn(cmd, " \n\t");
199 if (!strncasecmp(cmd, "winrate", 7)) {
200 if (!u->t)
201 return "no game context (yet?)";
202 enum stone color = u->t->root_color;
203 struct tree_node *n = u->t->root;
204 snprintf(reply, 1024, "In %d playouts at %d threads, %s %s can win with %.2f%% probability",
205 n->u.playouts, u->threads, stone2str(color), coord2sstr(n->coord, b),
206 tree_node_get_value(u->t, -1, n->u.value) * 100);
207 if (u->t->use_extra_komi && abs(u->t->extra_komi) >= 0.5) {
208 sprintf(reply + strlen(reply), ", while self-imposing extra komi %.1f",
209 u->t->extra_komi);
211 strcat(reply, ".");
212 return reply;
214 return NULL;
217 static void
218 uct_dead_group_list(struct engine *e, struct board *b, struct move_queue *mq)
220 struct uct *u = e->data;
222 /* This means the game is probably over, no use pondering on. */
223 uct_pondering_stop(u);
225 if (u->pass_all_alive)
226 return; // no dead groups
228 bool mock_state = false;
230 if (!u->t) {
231 /* No state, but we cannot just back out - we might
232 * have passed earlier, only assuming some stones are
233 * dead, and then re-connected, only to lose counting
234 * when all stones are assumed alive. */
235 uct_prepare_move(u, b, S_BLACK); assert(u->t);
236 mock_state = true;
238 /* Make sure the ownermap is well-seeded. */
239 while (u->ownermap.playouts < GJ_MINGAMES)
240 uct_playout(u, b, S_BLACK, u->t);
241 /* Show the ownermap: */
242 if (DEBUGL(2))
243 board_print_custom(b, stderr, uct_printhook_ownermap);
245 dead_group_list(u, b, mq);
247 if (mock_state) {
248 /* Clean up the mock state in case we will receive
249 * a genmove; we could get a non-alternating-move
250 * error from uct_prepare_move() in that case otherwise. */
251 reset_state(u);
255 static void
256 playout_policy_done(struct playout_policy *p)
258 if (p->done) p->done(p);
259 if (p->data) free(p->data);
260 free(p);
263 static void
264 uct_done(struct engine *e)
266 /* This is called on engine reset, especially when clear_board
267 * is received and new game should begin. */
268 struct uct *u = e->data;
269 uct_pondering_stop(u);
270 if (u->t) reset_state(u);
271 free(u->ownermap.map);
273 free(u->policy);
274 free(u->random_policy);
275 playout_policy_done(u->playout);
276 uct_prior_done(u->prior);
277 joseki_done(u->jdict);
278 pluginset_done(u->plugins);
283 /* Run time-limited MCTS search on foreground. */
284 static int
285 uct_search(struct uct *u, struct board *b, struct time_info *ti, enum stone color, struct tree *t)
287 struct uct_search_state s;
288 uct_search_start(u, b, color, t, ti, &s);
289 if (UDEBUGL(2) && s.base_playouts > 0)
290 fprintf(stderr, "<pre-simulated %d games>\n", s.base_playouts);
292 /* The search tree is ctx->t. This is currently == . It is important
293 * to reference ctx->t directly since the
294 * thread manager will swap the tree pointer asynchronously. */
296 /* Now, just periodically poll the search tree. */
297 while (1) {
298 time_sleep(TREE_BUSYWAIT_INTERVAL);
299 /* TREE_BUSYWAIT_INTERVAL should never be less than desired time, or the
300 * time control is broken. But if it happens to be less, we still search
301 * at least 100ms otherwise the move is completely random. */
303 int i = uct_search_games(&s);
304 /* Print notifications etc. */
305 uct_search_progress(u, b, color, t, ti, &s, i);
306 /* Check if we should stop the search. */
307 if (uct_search_check_stop(u, b, color, t, ti, &s, i))
308 break;
311 struct uct_thread_ctx *ctx = uct_search_stop();
312 if (UDEBUGL(2)) tree_dump(t, u->dumpthres);
313 if (UDEBUGL(2))
314 fprintf(stderr, "(avg score %f/%d value %f/%d)\n",
315 u->dynkomi->score.value, u->dynkomi->score.playouts,
316 u->dynkomi->value.value, u->dynkomi->value.playouts);
317 if (UDEBUGL(0))
318 uct_progress_status(u, t, color, ctx->games);
320 u->played_own += ctx->games;
321 return ctx->games;
324 /* Start pondering background with @color to play. */
325 static void
326 uct_pondering_start(struct uct *u, struct board *b0, struct tree *t, enum stone color)
328 if (UDEBUGL(1))
329 fprintf(stderr, "Starting to ponder with color %s\n", stone2str(stone_other(color)));
330 u->pondering = true;
332 /* We need a local board copy to ponder upon. */
333 struct board *b = malloc2(sizeof(*b)); board_copy(b, b0);
335 /* *b0 did not have the genmove'd move played yet. */
336 struct move m = { t->root->coord, t->root_color };
337 int res = board_play(b, &m);
338 assert(res >= 0);
339 setup_dynkomi(u, b, stone_other(m.color));
341 /* Start MCTS manager thread "headless". */
342 static struct uct_search_state s;
343 uct_search_start(u, b, color, t, NULL, &s);
346 /* uct_search_stop() frontend for the pondering (non-genmove) mode, and
347 * to stop the background search for a slave in the distributed engine. */
348 void
349 uct_pondering_stop(struct uct *u)
351 if (!thread_manager_running)
352 return;
354 /* Stop the thread manager. */
355 struct uct_thread_ctx *ctx = uct_search_stop();
356 if (UDEBUGL(1)) {
357 if (u->pondering) fprintf(stderr, "(pondering) ");
358 uct_progress_status(u, ctx->t, ctx->color, ctx->games);
360 if (u->pondering) {
361 free(ctx->b);
362 u->pondering = false;
367 void
368 uct_genmove_setup(struct uct *u, struct board *b, enum stone color)
370 if (b->superko_violation) {
371 fprintf(stderr, "!!! WARNING: SUPERKO VIOLATION OCCURED BEFORE THIS MOVE\n");
372 fprintf(stderr, "Maybe you play with situational instead of positional superko?\n");
373 fprintf(stderr, "I'm going to ignore the violation, but note that I may miss\n");
374 fprintf(stderr, "some moves valid under this ruleset because of this.\n");
375 b->superko_violation = false;
378 uct_prepare_move(u, b, color);
380 assert(u->t);
381 u->my_color = color;
383 /* How to decide whether to use dynkomi in this game? Since we use
384 * pondering, it's not simple "who-to-play" matter. Decide based on
385 * the last genmove issued. */
386 u->t->use_extra_komi = !!(u->dynkomi_mask & color);
387 /* Moreover, we do not use extra komi at the game end - we are not
388 * to fool ourselves at this point. */
389 if (board_estimated_moves_left(b) <= MIN_MOVES_LEFT)
390 u->t->use_extra_komi = false;
391 setup_dynkomi(u, b, color);
393 if (b->rules == RULES_JAPANESE)
394 u->territory_scoring = true;
396 /* Make pessimistic assumption about komi for Japanese rules to
397 * avoid losing by 0.5 when winning by 0.5 with Chinese rules.
398 * The rules usually give the same winner if the integer part of komi
399 * is odd so we adjust the komi only if it is even (for a board of
400 * odd size). We are not trying to get an exact evaluation for rare
401 * cases of seki. For details see http://home.snafu.de/jasiek/parity.html */
402 if (u->territory_scoring && (((int)floor(b->komi) + board_size(b)) & 1)) {
403 b->komi += (color == S_BLACK ? 1.0 : -1.0);
404 if (UDEBUGL(0))
405 fprintf(stderr, "Setting komi to %.1f assuming Japanese rules\n",
406 b->komi);
410 static coord_t *
411 uct_genmove(struct engine *e, struct board *b, struct time_info *ti, enum stone color, bool pass_all_alive)
413 double start_time = time_now();
414 struct uct *u = e->data;
415 uct_pondering_stop(u);
416 uct_genmove_setup(u, b, color);
418 /* Start the Monte Carlo Tree Search! */
419 int base_playouts = u->t->root->u.playouts;
420 int played_games = uct_search(u, b, ti, color, u->t);
422 coord_t best_coord;
423 struct tree_node *best;
424 best = uct_search_result(u, b, color, pass_all_alive, played_games, base_playouts, &best_coord);
426 if (UDEBUGL(2)) {
427 double time = time_now() - start_time + 0.000001; /* avoid divide by zero */
428 fprintf(stderr, "genmove in %0.2fs (%d games/s, %d games/s/thread)\n",
429 time, (int)(played_games/time), (int)(played_games/time/u->threads));
432 if (!best) {
433 /* Pass or resign. */
434 reset_state(u);
435 return coord_copy(best_coord);
437 tree_promote_node(u->t, &best);
439 /* After a pass, pondering is harmful for two reasons:
440 * (i) We might keep pondering even when the game is over.
441 * Of course this is the case for opponent resign as well.
442 * (ii) More importantly, the ownermap will get skewed since
443 * the UCT will start cutting off any playouts. */
444 if (u->pondering_opt && !is_pass(best->coord)) {
445 uct_pondering_start(u, b, u->t, stone_other(color));
447 return coord_copy(best_coord);
451 bool
452 uct_genbook(struct engine *e, struct board *b, struct time_info *ti, enum stone color)
454 struct uct *u = e->data;
455 if (!u->t) uct_prepare_move(u, b, color);
456 assert(u->t);
458 if (ti->dim == TD_GAMES) {
459 /* Don't count in games that already went into the book. */
460 ti->len.games += u->t->root->u.playouts;
462 uct_search(u, b, ti, color, u->t);
464 assert(ti->dim == TD_GAMES);
465 tree_save(u->t, b, ti->len.games / 100);
467 return true;
470 void
471 uct_dumpbook(struct engine *e, struct board *b, enum stone color)
473 struct uct *u = e->data;
474 struct tree *t = tree_init(b, color, u->fast_alloc ? u->max_tree_size : 0,
475 u->max_pruned_size, u->pruning_threshold, u->local_tree_aging, 0);
476 tree_load(t, b);
477 tree_dump(t, 0);
478 tree_done(t);
482 float
483 uct_evaluate(struct engine *e, struct board *b, struct time_info *ti, coord_t c, enum stone color)
485 struct uct *u = e->data;
487 struct board b2;
488 board_copy(&b2, b);
489 struct move m = { c, color };
490 int res = board_play(&b2, &m);
491 if (res < 0)
492 return NAN;
493 color = stone_other(color);
495 if (u->t) reset_state(u);
496 uct_prepare_move(u, &b2, color);
497 assert(u->t);
499 float bestval;
500 uct_search(u, &b2, ti, color, u->t);
501 struct tree_node *best = u->policy->choose(u->policy, u->t->root, &b2, color, resign);
502 if (!best) {
503 bestval = NAN; // the opponent has no reply!
504 } else {
505 bestval = tree_node_get_value(u->t, 1, best->u.value);
508 reset_state(u); // clean our junk
510 return isnan(bestval) ? NAN : 1.0f - bestval;
514 struct uct *
515 uct_state_init(char *arg, struct board *b)
517 struct uct *u = calloc2(1, sizeof(struct uct));
518 bool using_elo = false;
520 u->debug_level = debug_level;
521 u->gamelen = MC_GAMELEN;
522 u->resign_threshold = 0.2;
523 u->sure_win_threshold = 0.85;
524 u->mercymin = 0;
525 u->expand_p = 2;
526 u->dumpthres = 1000;
527 u->playout_amaf = true;
528 u->playout_amaf_nakade = false;
529 u->amaf_prior = false;
530 u->max_tree_size = 3072ULL * 1048576;
531 u->pruning_threshold = 0;
533 u->threads = 1;
534 u->thread_model = TM_TREEVL;
535 u->virtual_loss = true;
537 u->fuseki_end = 20; // max time at 361*20% = 72 moves (our 36th move, still 99 to play)
538 u->yose_start = 40; // (100-40-25)*361/100/2 = 63 moves still to play by us then
539 u->bestr_ratio = 0.02;
540 // 2.5 is clearly too much, but seems to compensate well for overly stern time allocations.
541 // TODO: Further tuning and experiments with better time allocation schemes.
542 u->best2_ratio = 2.5;
544 u->val_scale = 0.04; u->val_points = 40;
545 u->dynkomi_interval = 1000;
546 u->dynkomi_mask = S_BLACK | S_WHITE;
548 u->tenuki_d = 4;
549 u->local_tree_aging = 2;
551 u->plugins = pluginset_init(b);
553 u->jdict = joseki_load(b->size);
555 if (arg) {
556 char *optspec, *next = arg;
557 while (*next) {
558 optspec = next;
559 next += strcspn(next, ",");
560 if (*next) { *next++ = 0; } else { *next = 0; }
562 char *optname = optspec;
563 char *optval = strchr(optspec, '=');
564 if (optval) *optval++ = 0;
566 if (!strcasecmp(optname, "debug")) {
567 if (optval)
568 u->debug_level = atoi(optval);
569 else
570 u->debug_level++;
571 } else if (!strcasecmp(optname, "resign_threshold") && optval) {
572 /* Resign when this ratio of games is lost
573 * after GJ_MINGAMES sample is taken. */
574 u->resign_threshold = atof(optval);
575 } else if (!strcasecmp(optname, "sure_win_threshold") && optval) {
576 /* Stop reading when this ratio of games is won
577 * after PLAYOUT_EARLY_BREAK_MIN sample is
578 * taken. (Prevents stupid time losses,
579 * friendly to human opponents.) */
580 u->sure_win_threshold = atof(optval);
581 } else if (!strcasecmp(optname, "mercy") && optval) {
582 /* Minimal difference of black/white captures
583 * to stop playout - "Mercy Rule". Speeds up
584 * hopeless playouts at the expense of some
585 * accuracy. */
586 u->mercymin = atoi(optval);
587 } else if (!strcasecmp(optname, "gamelen") && optval) {
588 u->gamelen = atoi(optval);
589 } else if (!strcasecmp(optname, "expand_p") && optval) {
590 u->expand_p = atoi(optval);
591 } else if (!strcasecmp(optname, "dumpthres") && optval) {
592 u->dumpthres = atoi(optval);
593 } else if (!strcasecmp(optname, "best2_ratio") && optval) {
594 /* If set, prolong simulating while
595 * first_best/second_best playouts ratio
596 * is less than best2_ratio. */
597 u->best2_ratio = atof(optval);
598 } else if (!strcasecmp(optname, "bestr_ratio") && optval) {
599 /* If set, prolong simulating while
600 * best,best_best_child values delta
601 * is more than bestr_ratio. */
602 u->bestr_ratio = atof(optval);
603 } else if (!strcasecmp(optname, "playout_amaf")) {
604 /* Whether to include random playout moves in
605 * AMAF as well. (Otherwise, only tree moves
606 * are included in AMAF. Of course makes sense
607 * only in connection with an AMAF policy.) */
608 /* with-without: 55.5% (+-4.1) */
609 if (optval && *optval == '0')
610 u->playout_amaf = false;
611 else
612 u->playout_amaf = true;
613 } else if (!strcasecmp(optname, "playout_amaf_nakade")) {
614 /* Whether to include nakade moves from playouts
615 * in the AMAF statistics; this tends to nullify
616 * the playout_amaf effect by adding too much
617 * noise. */
618 if (optval && *optval == '0')
619 u->playout_amaf_nakade = false;
620 else
621 u->playout_amaf_nakade = true;
622 } else if (!strcasecmp(optname, "playout_amaf_cutoff") && optval) {
623 /* Keep only first N% of playout stage AMAF
624 * information. */
625 u->playout_amaf_cutoff = atoi(optval);
626 } else if ((!strcasecmp(optname, "policy") || !strcasecmp(optname, "random_policy")) && optval) {
627 char *policyarg = strchr(optval, ':');
628 struct uct_policy **p = !strcasecmp(optname, "policy") ? &u->policy : &u->random_policy;
629 if (policyarg)
630 *policyarg++ = 0;
631 if (!strcasecmp(optval, "ucb1")) {
632 *p = policy_ucb1_init(u, policyarg);
633 } else if (!strcasecmp(optval, "ucb1amaf")) {
634 *p = policy_ucb1amaf_init(u, policyarg);
635 } else {
636 fprintf(stderr, "UCT: Invalid tree policy %s\n", optval);
637 exit(1);
639 } else if (!strcasecmp(optname, "playout") && optval) {
640 char *playoutarg = strchr(optval, ':');
641 if (playoutarg)
642 *playoutarg++ = 0;
643 if (!strcasecmp(optval, "moggy")) {
644 u->playout = playout_moggy_init(playoutarg, b, u->jdict);
645 } else if (!strcasecmp(optval, "light")) {
646 u->playout = playout_light_init(playoutarg, b);
647 } else if (!strcasecmp(optval, "elo")) {
648 u->playout = playout_elo_init(playoutarg, b);
649 using_elo = true;
650 } else {
651 fprintf(stderr, "UCT: Invalid playout policy %s\n", optval);
652 exit(1);
654 } else if (!strcasecmp(optname, "prior") && optval) {
655 u->prior = uct_prior_init(optval, b);
656 } else if (!strcasecmp(optname, "amaf_prior") && optval) {
657 u->amaf_prior = atoi(optval);
658 } else if (!strcasecmp(optname, "threads") && optval) {
659 /* By default, Pachi will run with only single
660 * tree search thread! */
661 u->threads = atoi(optval);
662 } else if (!strcasecmp(optname, "thread_model") && optval) {
663 if (!strcasecmp(optval, "tree")) {
664 /* Tree parallelization - all threads
665 * grind on the same tree. */
666 u->thread_model = TM_TREE;
667 u->virtual_loss = false;
668 } else if (!strcasecmp(optval, "treevl")) {
669 /* Tree parallelization, but also
670 * with virtual losses - this discou-
671 * rages most threads choosing the
672 * same tree branches to read. */
673 u->thread_model = TM_TREEVL;
674 u->virtual_loss = true;
675 } else {
676 fprintf(stderr, "UCT: Invalid thread model %s\n", optval);
677 exit(1);
679 } else if (!strcasecmp(optname, "pondering")) {
680 /* Keep searching even during opponent's turn. */
681 u->pondering_opt = !optval || atoi(optval);
682 } else if (!strcasecmp(optname, "fuseki_end") && optval) {
683 /* At the very beginning it's not worth thinking
684 * too long because the playout evaluations are
685 * very noisy. So gradually increase the thinking
686 * time up to maximum when fuseki_end percent
687 * of the board has been played.
688 * This only applies if we are not in byoyomi. */
689 u->fuseki_end = atoi(optval);
690 } else if (!strcasecmp(optname, "yose_start") && optval) {
691 /* When yose_start percent of the board has been
692 * played, or if we are in byoyomi, stop spending
693 * more time and spread the remaining time
694 * uniformly.
695 * Between fuseki_end and yose_start, we spend
696 * a constant proportion of the remaining time
697 * on each move. (yose_start should actually
698 * be much earlier than when real yose start,
699 * but "yose" is a good short name to convey
700 * the idea.) */
701 u->yose_start = atoi(optval);
702 } else if (!strcasecmp(optname, "force_seed") && optval) {
703 u->force_seed = atoi(optval);
704 } else if (!strcasecmp(optname, "no_book")) {
705 u->no_book = true;
706 } else if (!strcasecmp(optname, "dynkomi") && optval) {
707 /* Dynamic komi approach; there are multiple
708 * ways to adjust komi dynamically throughout
709 * play. We currently support two: */
710 char *dynkomiarg = strchr(optval, ':');
711 if (dynkomiarg)
712 *dynkomiarg++ = 0;
713 if (!strcasecmp(optval, "none")) {
714 u->dynkomi = uct_dynkomi_init_none(u, dynkomiarg, b);
715 } else if (!strcasecmp(optval, "linear")) {
716 /* You should set dynkomi_mask=1
717 * since this doesn't work well
718 * for white handicaps! */
719 u->dynkomi = uct_dynkomi_init_linear(u, dynkomiarg, b);
720 } else if (!strcasecmp(optval, "adaptive")) {
721 /* There are many more knobs to
722 * crank - see uct/dynkomi.c. */
723 u->dynkomi = uct_dynkomi_init_adaptive(u, dynkomiarg, b);
724 } else {
725 fprintf(stderr, "UCT: Invalid dynkomi mode %s\n", optval);
726 exit(1);
728 } else if (!strcasecmp(optname, "dynkomi_mask") && optval) {
729 /* Bitmask of colors the player must be
730 * for dynkomi be applied; you may want
731 * to use dynkomi_mask=3 to allow dynkomi
732 * even in games where Pachi is white. */
733 u->dynkomi_mask = atoi(optval);
734 } else if (!strcasecmp(optname, "dynkomi_interval") && optval) {
735 /* If non-zero, re-adjust dynamic komi
736 * throughout a single genmove reading,
737 * roughly every N simulations. */
738 /* XXX: Does not work with tree
739 * parallelization. */
740 u->dynkomi_interval = atoi(optval);
741 } else if (!strcasecmp(optname, "val_scale") && optval) {
742 /* How much of the game result value should be
743 * influenced by win size. Zero means it isn't. */
744 u->val_scale = atof(optval);
745 } else if (!strcasecmp(optname, "val_points") && optval) {
746 /* Maximum size of win to be scaled into game
747 * result value. Zero means boardsize^2. */
748 u->val_points = atoi(optval) * 2; // result values are doubled
749 } else if (!strcasecmp(optname, "val_extra")) {
750 /* If false, the score coefficient will be simply
751 * added to the value, instead of scaling the result
752 * coefficient because of it. */
753 u->val_extra = !optval || atoi(optval);
754 } else if (!strcasecmp(optname, "local_tree") && optval) {
755 /* Whether to bias exploration by local tree values
756 * (must be supported by the used policy).
757 * 0: Don't.
758 * 1: Do, value = result.
759 * Try to temper the result:
760 * 2: Do, value = 0.5+(result-expected)/2.
761 * 3: Do, value = 0.5+bzz((result-expected)^2).
762 * 4: Do, value = 0.5+sqrt(result-expected)/2. */
763 u->local_tree = atoi(optval);
764 } else if (!strcasecmp(optname, "tenuki_d") && optval) {
765 /* Tenuki distance at which to break the local tree. */
766 u->tenuki_d = atoi(optval);
767 if (u->tenuki_d > TREE_NODE_D_MAX + 1) {
768 fprintf(stderr, "uct: tenuki_d must not be larger than TREE_NODE_D_MAX+1 %d\n", TREE_NODE_D_MAX + 1);
769 exit(1);
771 } else if (!strcasecmp(optname, "local_tree_aging") && optval) {
772 /* How much to reduce local tree values between moves. */
773 u->local_tree_aging = atof(optval);
774 } else if (!strcasecmp(optname, "local_tree_allseq")) {
775 /* By default, only complete sequences are stored
776 * in the local tree. If this is on, also
777 * subsequences starting at each move are stored. */
778 u->local_tree_allseq = !optval || atoi(optval);
779 } else if (!strcasecmp(optname, "local_tree_playout")) {
780 /* Whether to adjust ELO playout probability
781 * distributions according to matched localtree
782 * information. */
783 u->local_tree_playout = !optval || atoi(optval);
784 } else if (!strcasecmp(optname, "local_tree_pseqroot")) {
785 /* By default, when we have no sequence move
786 * to suggest in-playout, we give up. If this
787 * is on, we make probability distribution from
788 * sequences first moves instead. */
789 u->local_tree_pseqroot = !optval || atoi(optval);
790 } else if (!strcasecmp(optname, "pass_all_alive")) {
791 /* Whether to consider passing only after all
792 * dead groups were removed from the board;
793 * this is like all genmoves are in fact
794 * kgs-genmove_cleanup. */
795 u->pass_all_alive = !optval || atoi(optval);
796 } else if (!strcasecmp(optname, "territory_scoring")) {
797 /* Use territory scoring (default is area scoring).
798 * An explicit kgs-rules command overrides this. */
799 u->territory_scoring = !optval || atoi(optval);
800 } else if (!strcasecmp(optname, "random_policy_chance") && optval) {
801 /* If specified (N), with probability 1/N, random_policy policy
802 * descend is used instead of main policy descend; useful
803 * if specified policy (e.g. UCB1AMAF) can make unduly biased
804 * choices sometimes, you can fall back to e.g.
805 * random_policy=UCB1. */
806 u->random_policy_chance = atoi(optval);
807 } else if (!strcasecmp(optname, "max_tree_size") && optval) {
808 /* Maximum amount of memory [MiB] consumed by the move tree.
809 * For fast_alloc it includes the temp tree used for pruning.
810 * Default is 3072 (3 GiB). */
811 u->max_tree_size = atol(optval) * 1048576;
812 } else if (!strcasecmp(optname, "pruning_threshold") && optval) {
813 /* Force pruning at beginning of a move if the tree consumes
814 * more than this [MiB]. Default is 10% of max_tree_size.
815 * Increase to reduce pruning time overhead if memory is plentiful.
816 * This option is meaningful only for fast_alloc. */
817 u->pruning_threshold = atol(optval) * 1048576;
818 } else if (!strcasecmp(optname, "fast_alloc")) {
819 u->fast_alloc = !optval || atoi(optval);
820 } else if (!strcasecmp(optname, "slave")) {
821 /* Act as slave for the distributed engine. */
822 u->slave = !optval || atoi(optval);
823 } else if (!strcasecmp(optname, "shared_nodes") && optval) {
824 /* Share at most shared_nodes between master and slave at each genmoves.
825 * Must use the same value in master and slaves. */
826 u->shared_nodes = atoi(optval);
827 } else if (!strcasecmp(optname, "shared_levels") && optval) {
828 /* Share only nodes of level <= shared_levels. */
829 u->shared_levels = atoi(optval);
830 } else if (!strcasecmp(optname, "stats_hbits") && optval) {
831 /* Set hash table size to 2^stats_hbits for the shared stats. */
832 u->stats_hbits = atoi(optval);
833 } else if (!strcasecmp(optname, "banner") && optval) {
834 /* Additional banner string. This must come as the
835 * last engine parameter. */
836 if (*next) *--next = ',';
837 u->banner = strdup(optval);
838 break;
839 } else if (!strcasecmp(optname, "plugin") && optval) {
840 /* Load an external plugin; filename goes before the colon,
841 * extra arguments after the colon. */
842 char *pluginarg = strchr(optval, ':');
843 if (pluginarg)
844 *pluginarg++ = 0;
845 plugin_load(u->plugins, optval, pluginarg);
846 } else {
847 fprintf(stderr, "uct: Invalid engine argument %s or missing value\n", optname);
848 exit(1);
853 if (!u->policy)
854 u->policy = policy_ucb1amaf_init(u, NULL);
856 if (!!u->random_policy_chance ^ !!u->random_policy) {
857 fprintf(stderr, "uct: Only one of random_policy and random_policy_chance is set\n");
858 exit(1);
861 if (!u->local_tree) {
862 /* No ltree aging. */
863 u->local_tree_aging = 1.0f;
865 if (!using_elo)
866 u->local_tree_playout = false;
868 if (u->fast_alloc) {
869 if (u->pruning_threshold < u->max_tree_size / 10)
870 u->pruning_threshold = u->max_tree_size / 10;
871 if (u->pruning_threshold > u->max_tree_size / 2)
872 u->pruning_threshold = u->max_tree_size / 2;
874 /* Limit pruning temp space to 20% of memory. Beyond this we discard
875 * the nodes and recompute them at the next move if necessary. */
876 u->max_pruned_size = u->max_tree_size / 5;
877 u->max_tree_size -= u->max_pruned_size;
878 } else {
879 /* Reserve 5% memory in case the background free() are slower
880 * than the concurrent allocations. */
881 u->max_tree_size -= u->max_tree_size / 20;
884 if (!u->prior)
885 u->prior = uct_prior_init(NULL, b);
887 if (!u->playout)
888 u->playout = playout_moggy_init(NULL, b, u->jdict);
889 if (!u->playout->debug_level)
890 u->playout->debug_level = u->debug_level;
892 u->ownermap.map = malloc2(board_size2(b) * sizeof(u->ownermap.map[0]));
894 if (u->slave) {
895 if (!u->stats_hbits) u->stats_hbits = DEFAULT_STATS_HBITS;
896 if (!u->shared_nodes) u->shared_nodes = DEFAULT_SHARED_NODES;
897 assert(u->shared_levels * board_bits2(b) <= 8 * (int)sizeof(path_t));
900 if (!u->dynkomi)
901 u->dynkomi = uct_dynkomi_init_adaptive(u, NULL, b);
903 /* Some things remain uninitialized for now - the opening book
904 * is not loaded and the tree not set up. */
905 /* This will be initialized in setup_state() at the first move
906 * received/requested. This is because right now we are not aware
907 * about any komi or handicap setup and such. */
909 return u;
912 struct engine *
913 engine_uct_init(char *arg, struct board *b)
915 struct uct *u = uct_state_init(arg, b);
916 struct engine *e = calloc2(1, sizeof(struct engine));
917 e->name = "UCT Engine";
918 e->printhook = uct_printhook_ownermap;
919 e->notify_play = uct_notify_play;
920 e->chat = uct_chat;
921 e->result = uct_result;
922 e->genmove = uct_genmove;
923 e->genmoves = uct_genmoves;
924 e->dead_group_list = uct_dead_group_list;
925 e->done = uct_done;
926 e->data = u;
927 if (u->slave)
928 e->notify = uct_notify;
930 const char banner[] = "I'm playing UCT. When I'm losing, I will resign, "
931 "if I think I win, I play until you pass. "
932 "Anyone can send me 'winrate' in private chat to get my assessment of the position.";
933 if (!u->banner) u->banner = "";
934 e->comment = malloc2(sizeof(banner) + strlen(u->banner) + 1);
935 sprintf(e->comment, "%s %s", banner, u->banner);
937 return e;