15 #include "joseki/base.h"
17 #include "playout/elo.h"
18 #include "playout/moggy.h"
19 #include "playout/light.h"
20 #include "tactics/util.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"
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
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
);
46 fast_srandom(u
->force_seed
);
48 fprintf(stderr
, "Fresh board with random seed %lu\n", fast_getseed());
49 //board_print(b, stderr);
50 if (!u
->no_tbook
&& b
->moves
== 0) {
51 assert(color
== S_BLACK
);
57 reset_state(struct uct
*u
)
60 tree_done(u
->t
); u
->t
= NULL
;
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
)
73 uct_prepare_move(struct uct
*u
, struct board
*b
, enum stone color
)
76 /* Verify that we have sane state. */
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
);
84 uct_htable_reset(u
->t
);
87 /* We need fresh state. */
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;
98 dead_group_list(struct uct
*u
, struct board
*b
, struct move_queue
*mq
)
100 struct group_judgement gj
;
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
);
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
)
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
);
121 uct_printhook_ownermap(struct board
*board
, coord_t c
, char *s
, char *end
)
123 struct uct
*u
= board
->es
;
128 const char chr
[] = ":XO,"; // dame, black, white, unclear
129 const char chm
[] = ":xo,";
130 char ch
= chr
[board_ownermap_judge_point(&u
->ownermap
, c
, GJ_THRES
)];
131 if (ch
== ',') { // less precise estimate then?
132 ch
= chm
[board_ownermap_judge_point(&u
->ownermap
, c
, 0.67)];
134 s
+= snprintf(s
, end
- s
, "%c ", ch
);
139 uct_notify_play(struct engine
*e
, struct board
*b
, struct move
*m
)
141 struct uct
*u
= e
->data
;
143 /* No state, create one - this is probably game beginning
144 * and we need to load the opening tbook right now. */
145 uct_prepare_move(u
, b
, m
->color
);
149 /* Stop pondering, required by tree_promote_at() */
150 uct_pondering_stop(u
);
151 if (UDEBUGL(2) && u
->slave
)
152 tree_dump(u
->t
, u
->dumpthres
);
154 if (is_resign(m
->coord
)) {
160 /* Promote node of the appropriate move to the tree root. */
162 if (!tree_promote_at(u
->t
, b
, m
->coord
)) {
164 fprintf(stderr
, "Warning: Cannot promote move node! Several play commands in row?\n");
169 /* If we are a slave in a distributed engine, start pondering once
170 * we know which move we actually played. See uct_genmove() about
171 * the check for pass. */
172 if (u
->pondering_opt
&& u
->slave
&& m
->color
== u
->my_color
&& !is_pass(m
->coord
))
173 uct_pondering_start(u
, b
, u
->t
, stone_other(m
->color
));
179 uct_result(struct engine
*e
, struct board
*b
)
181 struct uct
*u
= e
->data
;
182 static char reply
[1024];
186 enum stone color
= u
->t
->root_color
;
187 struct tree_node
*n
= u
->t
->root
;
188 snprintf(reply
, 1024, "%s %s %d %.2f %.1f",
189 stone2str(color
), coord2sstr(n
->coord
, b
),
190 n
->u
.playouts
, tree_node_get_value(u
->t
, -1, n
->u
.value
),
191 u
->t
->use_extra_komi
? u
->t
->extra_komi
: 0);
196 uct_chat(struct engine
*e
, struct board
*b
, char *cmd
)
198 struct uct
*u
= e
->data
;
199 static char reply
[1024];
201 cmd
+= strspn(cmd
, " \n\t");
202 if (!strncasecmp(cmd
, "winrate", 7)) {
204 return "no game context (yet?)";
205 enum stone color
= u
->t
->root_color
;
206 struct tree_node
*n
= u
->t
->root
;
207 snprintf(reply
, 1024, "In %d playouts at %d threads, %s %s can win with %.2f%% probability",
208 n
->u
.playouts
, u
->threads
, stone2str(color
), coord2sstr(n
->coord
, b
),
209 tree_node_get_value(u
->t
, -1, n
->u
.value
) * 100);
210 if (u
->t
->use_extra_komi
&& abs(u
->t
->extra_komi
) >= 0.5) {
211 sprintf(reply
+ strlen(reply
), ", while self-imposing extra komi %.1f",
221 uct_dead_group_list(struct engine
*e
, struct board
*b
, struct move_queue
*mq
)
223 struct uct
*u
= e
->data
;
225 /* This means the game is probably over, no use pondering on. */
226 uct_pondering_stop(u
);
228 if (u
->pass_all_alive
)
229 return; // no dead groups
231 bool mock_state
= false;
234 /* No state, but we cannot just back out - we might
235 * have passed earlier, only assuming some stones are
236 * dead, and then re-connected, only to lose counting
237 * when all stones are assumed alive. */
238 uct_prepare_move(u
, b
, S_BLACK
); assert(u
->t
);
241 /* Make sure the ownermap is well-seeded. */
242 while (u
->ownermap
.playouts
< GJ_MINGAMES
)
243 uct_playout(u
, b
, S_BLACK
, u
->t
);
244 /* Show the ownermap: */
246 board_print_custom(b
, stderr
, uct_printhook_ownermap
);
248 dead_group_list(u
, b
, mq
);
251 /* Clean up the mock state in case we will receive
252 * a genmove; we could get a non-alternating-move
253 * error from uct_prepare_move() in that case otherwise. */
259 playout_policy_done(struct playout_policy
*p
)
261 if (p
->done
) p
->done(p
);
262 if (p
->data
) free(p
->data
);
267 uct_done(struct engine
*e
)
269 /* This is called on engine reset, especially when clear_board
270 * is received and new game should begin. */
271 struct uct
*u
= e
->data
;
272 uct_pondering_stop(u
);
273 if (u
->t
) reset_state(u
);
274 free(u
->ownermap
.map
);
277 free(u
->random_policy
);
278 playout_policy_done(u
->playout
);
279 uct_prior_done(u
->prior
);
280 joseki_done(u
->jdict
);
281 pluginset_done(u
->plugins
);
286 /* Run time-limited MCTS search on foreground. */
288 uct_search(struct uct
*u
, struct board
*b
, struct time_info
*ti
, enum stone color
, struct tree
*t
)
290 struct uct_search_state s
;
291 uct_search_start(u
, b
, color
, t
, ti
, &s
);
292 if (UDEBUGL(2) && s
.base_playouts
> 0)
293 fprintf(stderr
, "<pre-simulated %d games>\n", s
.base_playouts
);
295 /* The search tree is ctx->t. This is currently == . It is important
296 * to reference ctx->t directly since the
297 * thread manager will swap the tree pointer asynchronously. */
299 /* Now, just periodically poll the search tree. */
300 /* Note that in case of TD_GAMES, threads will terminate independently
301 * of the uct_search_check_stop() signalization. */
303 time_sleep(TREE_BUSYWAIT_INTERVAL
);
304 /* TREE_BUSYWAIT_INTERVAL should never be less than desired time, or the
305 * time control is broken. But if it happens to be less, we still search
306 * at least 100ms otherwise the move is completely random. */
308 int i
= uct_search_games(&s
);
309 /* Print notifications etc. */
310 uct_search_progress(u
, b
, color
, t
, ti
, &s
, i
);
311 /* Check if we should stop the search. */
312 if (uct_search_check_stop(u
, b
, color
, t
, ti
, &s
, i
))
316 struct uct_thread_ctx
*ctx
= uct_search_stop();
317 if (UDEBUGL(2)) tree_dump(t
, u
->dumpthres
);
319 fprintf(stderr
, "(avg score %f/%d value %f/%d)\n",
320 u
->dynkomi
->score
.value
, u
->dynkomi
->score
.playouts
,
321 u
->dynkomi
->value
.value
, u
->dynkomi
->value
.playouts
);
323 uct_progress_status(u
, t
, color
, ctx
->games
);
325 u
->played_own
+= ctx
->games
;
329 /* Start pondering background with @color to play. */
331 uct_pondering_start(struct uct
*u
, struct board
*b0
, struct tree
*t
, enum stone color
)
334 fprintf(stderr
, "Starting to ponder with color %s\n", stone2str(stone_other(color
)));
337 /* We need a local board copy to ponder upon. */
338 struct board
*b
= malloc2(sizeof(*b
)); board_copy(b
, b0
);
340 /* *b0 did not have the genmove'd move played yet. */
341 struct move m
= { t
->root
->coord
, t
->root_color
};
342 int res
= board_play(b
, &m
);
344 setup_dynkomi(u
, b
, stone_other(m
.color
));
346 /* Start MCTS manager thread "headless". */
347 static struct uct_search_state s
;
348 uct_search_start(u
, b
, color
, t
, NULL
, &s
);
351 /* uct_search_stop() frontend for the pondering (non-genmove) mode, and
352 * to stop the background search for a slave in the distributed engine. */
354 uct_pondering_stop(struct uct
*u
)
356 if (!thread_manager_running
)
359 /* Stop the thread manager. */
360 struct uct_thread_ctx
*ctx
= uct_search_stop();
362 if (u
->pondering
) fprintf(stderr
, "(pondering) ");
363 uct_progress_status(u
, ctx
->t
, ctx
->color
, ctx
->games
);
367 u
->pondering
= false;
373 uct_genmove_setup(struct uct
*u
, struct board
*b
, enum stone color
)
375 if (b
->superko_violation
) {
376 fprintf(stderr
, "!!! WARNING: SUPERKO VIOLATION OCCURED BEFORE THIS MOVE\n");
377 fprintf(stderr
, "Maybe you play with situational instead of positional superko?\n");
378 fprintf(stderr
, "I'm going to ignore the violation, but note that I may miss\n");
379 fprintf(stderr
, "some moves valid under this ruleset because of this.\n");
380 b
->superko_violation
= false;
383 uct_prepare_move(u
, b
, color
);
388 /* How to decide whether to use dynkomi in this game? Since we use
389 * pondering, it's not simple "who-to-play" matter. Decide based on
390 * the last genmove issued. */
391 u
->t
->use_extra_komi
= !!(u
->dynkomi_mask
& color
);
392 /* Moreover, we do not use extra komi at the game end - we are not
393 * to fool ourselves at this point. */
394 if (board_estimated_moves_left(b
) <= MIN_MOVES_LEFT
)
395 u
->t
->use_extra_komi
= false;
396 setup_dynkomi(u
, b
, color
);
398 if (b
->rules
== RULES_JAPANESE
)
399 u
->territory_scoring
= true;
401 /* Make pessimistic assumption about komi for Japanese rules to
402 * avoid losing by 0.5 when winning by 0.5 with Chinese rules.
403 * The rules usually give the same winner if the integer part of komi
404 * is odd so we adjust the komi only if it is even (for a board of
405 * odd size). We are not trying to get an exact evaluation for rare
406 * cases of seki. For details see http://home.snafu.de/jasiek/parity.html */
407 if (u
->territory_scoring
&& (((int)floor(b
->komi
) + board_size(b
)) & 1)) {
408 b
->komi
+= (color
== S_BLACK
? 1.0 : -1.0);
410 fprintf(stderr
, "Setting komi to %.1f assuming Japanese rules\n",
416 uct_genmove(struct engine
*e
, struct board
*b
, struct time_info
*ti
, enum stone color
, bool pass_all_alive
)
418 double start_time
= time_now();
419 struct uct
*u
= e
->data
;
420 uct_pondering_stop(u
);
421 uct_genmove_setup(u
, b
, color
);
423 /* Start the Monte Carlo Tree Search! */
424 int base_playouts
= u
->t
->root
->u
.playouts
;
425 int played_games
= uct_search(u
, b
, ti
, color
, u
->t
);
428 struct tree_node
*best
;
429 best
= uct_search_result(u
, b
, color
, pass_all_alive
, played_games
, base_playouts
, &best_coord
);
432 double time
= time_now() - start_time
+ 0.000001; /* avoid divide by zero */
433 fprintf(stderr
, "genmove in %0.2fs (%d games/s, %d games/s/thread)\n",
434 time
, (int)(played_games
/time
), (int)(played_games
/time
/u
->threads
));
438 /* Pass or resign. */
440 return coord_copy(best_coord
);
442 tree_promote_node(u
->t
, &best
);
444 /* After a pass, pondering is harmful for two reasons:
445 * (i) We might keep pondering even when the game is over.
446 * Of course this is the case for opponent resign as well.
447 * (ii) More importantly, the ownermap will get skewed since
448 * the UCT will start cutting off any playouts. */
449 if (u
->pondering_opt
&& !is_pass(best
->coord
)) {
450 uct_pondering_start(u
, b
, u
->t
, stone_other(color
));
452 return coord_copy(best_coord
);
457 uct_gentbook(struct engine
*e
, struct board
*b
, struct time_info
*ti
, enum stone color
)
459 struct uct
*u
= e
->data
;
460 if (!u
->t
) uct_prepare_move(u
, b
, color
);
463 if (ti
->dim
== TD_GAMES
) {
464 /* Don't count in games that already went into the tbook. */
465 ti
->len
.games
+= u
->t
->root
->u
.playouts
;
467 uct_search(u
, b
, ti
, color
, u
->t
);
469 assert(ti
->dim
== TD_GAMES
);
470 tree_save(u
->t
, b
, ti
->len
.games
/ 100);
476 uct_dumptbook(struct engine
*e
, struct board
*b
, enum stone color
)
478 struct uct
*u
= e
->data
;
479 struct tree
*t
= tree_init(b
, color
, u
->fast_alloc
? u
->max_tree_size
: 0,
480 u
->max_pruned_size
, u
->pruning_threshold
, u
->local_tree_aging
, 0);
488 uct_evaluate(struct engine
*e
, struct board
*b
, struct time_info
*ti
, coord_t c
, enum stone color
)
490 struct uct
*u
= e
->data
;
494 struct move m
= { c
, color
};
495 int res
= board_play(&b2
, &m
);
498 color
= stone_other(color
);
500 if (u
->t
) reset_state(u
);
501 uct_prepare_move(u
, &b2
, color
);
505 uct_search(u
, &b2
, ti
, color
, u
->t
);
506 struct tree_node
*best
= u
->policy
->choose(u
->policy
, u
->t
->root
, &b2
, color
, resign
);
508 bestval
= NAN
; // the opponent has no reply!
510 bestval
= tree_node_get_value(u
->t
, 1, best
->u
.value
);
513 reset_state(u
); // clean our junk
515 return isnan(bestval
) ? NAN
: 1.0f
- bestval
;
520 uct_state_init(char *arg
, struct board
*b
)
522 struct uct
*u
= calloc2(1, sizeof(struct uct
));
523 bool using_elo
= false;
525 u
->debug_level
= debug_level
;
526 u
->gamelen
= MC_GAMELEN
;
527 u
->resign_threshold
= 0.2;
528 u
->sure_win_threshold
= 0.85;
530 u
->significant_threshold
= 50;
533 u
->playout_amaf
= true;
534 u
->playout_amaf_nakade
= false;
535 u
->amaf_prior
= false;
536 u
->max_tree_size
= 3072ULL * 1048576;
537 u
->pruning_threshold
= 0;
540 u
->thread_model
= TM_TREEVL
;
543 u
->fuseki_end
= 20; // max time at 361*20% = 72 moves (our 36th move, still 99 to play)
544 u
->yose_start
= 40; // (100-40-25)*361/100/2 = 63 moves still to play by us then
545 u
->bestr_ratio
= 0.02;
546 // 2.5 is clearly too much, but seems to compensate well for overly stern time allocations.
547 // TODO: Further tuning and experiments with better time allocation schemes.
548 u
->best2_ratio
= 2.5;
549 u
->max_maintime_ratio
= 3.0;
551 u
->val_scale
= 0.04; u
->val_points
= 40;
552 u
->dynkomi_interval
= 1000;
553 u
->dynkomi_mask
= S_BLACK
| S_WHITE
;
556 u
->local_tree_aging
= 80;
557 u
->local_tree_allseq
= 1;
558 u
->local_tree_rootseqval
= 1;
559 u
->local_tree_depth_decay
= 1.5;
561 u
->plugins
= pluginset_init(b
);
563 u
->jdict
= joseki_load(b
->size
);
566 char *optspec
, *next
= arg
;
569 next
+= strcspn(next
, ",");
570 if (*next
) { *next
++ = 0; } else { *next
= 0; }
572 char *optname
= optspec
;
573 char *optval
= strchr(optspec
, '=');
574 if (optval
) *optval
++ = 0;
578 if (!strcasecmp(optname
, "debug")) {
580 u
->debug_level
= atoi(optval
);
583 } else if (!strcasecmp(optname
, "dumpthres") && optval
) {
584 /* When dumping the UCT tree on output, include
585 * nodes with at least this many playouts.
586 * (This value is re-scaled "intelligently"
587 * in case of very large trees.) */
588 u
->dumpthres
= atoi(optval
);
589 } else if (!strcasecmp(optname
, "resign_threshold") && optval
) {
590 /* Resign when this ratio of games is lost
591 * after GJ_MINGAMES sample is taken. */
592 u
->resign_threshold
= atof(optval
);
593 } else if (!strcasecmp(optname
, "sure_win_threshold") && optval
) {
594 /* Stop reading when this ratio of games is won
595 * after PLAYOUT_EARLY_BREAK_MIN sample is
596 * taken. (Prevents stupid time losses,
597 * friendly to human opponents.) */
598 u
->sure_win_threshold
= atof(optval
);
599 } else if (!strcasecmp(optname
, "force_seed") && optval
) {
600 /* Set RNG seed at the tree setup. */
601 u
->force_seed
= atoi(optval
);
602 } else if (!strcasecmp(optname
, "no_tbook")) {
603 /* Disable UCT opening tbook. */
605 } else if (!strcasecmp(optname
, "pass_all_alive")) {
606 /* Whether to consider passing only after all
607 * dead groups were removed from the board;
608 * this is like all genmoves are in fact
609 * kgs-genmove_cleanup. */
610 u
->pass_all_alive
= !optval
|| atoi(optval
);
611 } else if (!strcasecmp(optname
, "territory_scoring")) {
612 /* Use territory scoring (default is area scoring).
613 * An explicit kgs-rules command overrides this. */
614 u
->territory_scoring
= !optval
|| atoi(optval
);
615 } else if (!strcasecmp(optname
, "banner") && optval
) {
616 /* Additional banner string. This must come as the
617 * last engine parameter. */
618 if (*next
) *--next
= ',';
619 u
->banner
= strdup(optval
);
621 } else if (!strcasecmp(optname
, "plugin") && optval
) {
622 /* Load an external plugin; filename goes before the colon,
623 * extra arguments after the colon. */
624 char *pluginarg
= strchr(optval
, ':');
627 plugin_load(u
->plugins
, optval
, pluginarg
);
629 /** UCT behavior and policies */
631 } else if ((!strcasecmp(optname
, "policy")
632 /* Node selection policy. ucb1amaf is the
633 * default policy implementing RAVE, while
634 * ucb1 is the simple exploration/exploitation
635 * policy. Policies can take further extra
637 || !strcasecmp(optname
, "random_policy")) && optval
) {
638 /* A policy to be used randomly with small
639 * chance instead of the default policy. */
640 char *policyarg
= strchr(optval
, ':');
641 struct uct_policy
**p
= !strcasecmp(optname
, "policy") ? &u
->policy
: &u
->random_policy
;
644 if (!strcasecmp(optval
, "ucb1")) {
645 *p
= policy_ucb1_init(u
, policyarg
);
646 } else if (!strcasecmp(optval
, "ucb1amaf")) {
647 *p
= policy_ucb1amaf_init(u
, policyarg
);
649 fprintf(stderr
, "UCT: Invalid tree policy %s\n", optval
);
652 } else if (!strcasecmp(optname
, "playout") && optval
) {
653 /* Random simulation (playout) policy.
654 * moggy is the default policy with large
655 * amount of domain-specific knowledge and
656 * heuristics. light is a simple uniformly
657 * random move selection policy. */
658 char *playoutarg
= strchr(optval
, ':');
661 if (!strcasecmp(optval
, "moggy")) {
662 u
->playout
= playout_moggy_init(playoutarg
, b
, u
->jdict
);
663 } else if (!strcasecmp(optval
, "light")) {
664 u
->playout
= playout_light_init(playoutarg
, b
);
665 } else if (!strcasecmp(optval
, "elo")) {
666 u
->playout
= playout_elo_init(playoutarg
, b
);
669 fprintf(stderr
, "UCT: Invalid playout policy %s\n", optval
);
672 } else if (!strcasecmp(optname
, "prior") && optval
) {
673 /* Node priors policy. When expanding a node,
674 * it will seed node values heuristically
675 * (most importantly, based on playout policy
676 * opinion, but also with regard to other
677 * things). See uct/prior.c for details.
678 * Use prior=eqex=0 to disable priors. */
679 u
->prior
= uct_prior_init(optval
, b
);
680 } else if (!strcasecmp(optname
, "mercy") && optval
) {
681 /* Minimal difference of black/white captures
682 * to stop playout - "Mercy Rule". Speeds up
683 * hopeless playouts at the expense of some
685 u
->mercymin
= atoi(optval
);
686 } else if (!strcasecmp(optname
, "gamelen") && optval
) {
687 /* Maximum length of single simulation
689 u
->gamelen
= atoi(optval
);
690 } else if (!strcasecmp(optname
, "expand_p") && optval
) {
691 /* Expand UCT nodes after it has been
692 * visited this many times. */
693 u
->expand_p
= atoi(optval
);
694 } else if (!strcasecmp(optname
, "random_policy_chance") && optval
) {
695 /* If specified (N), with probability 1/N, random_policy policy
696 * descend is used instead of main policy descend; useful
697 * if specified policy (e.g. UCB1AMAF) can make unduly biased
698 * choices sometimes, you can fall back to e.g.
699 * random_policy=UCB1. */
700 u
->random_policy_chance
= atoi(optval
);
702 /** General AMAF behavior */
703 /* (Only relevant if the policy supports AMAF.
704 * More variables can be tuned as policy
707 } else if (!strcasecmp(optname
, "playout_amaf")) {
708 /* Whether to include random playout moves in
709 * AMAF as well. (Otherwise, only tree moves
710 * are included in AMAF. Of course makes sense
711 * only in connection with an AMAF policy.) */
712 /* with-without: 55.5% (+-4.1) */
713 if (optval
&& *optval
== '0')
714 u
->playout_amaf
= false;
716 u
->playout_amaf
= true;
717 } else if (!strcasecmp(optname
, "playout_amaf_nakade")) {
718 /* Whether to include nakade moves from playouts
719 * in the AMAF statistics; this tends to nullify
720 * the playout_amaf effect by adding too much
722 if (optval
&& *optval
== '0')
723 u
->playout_amaf_nakade
= false;
725 u
->playout_amaf_nakade
= true;
726 } else if (!strcasecmp(optname
, "playout_amaf_cutoff") && optval
) {
727 /* Keep only first N% of playout stage AMAF
729 u
->playout_amaf_cutoff
= atoi(optval
);
730 } else if (!strcasecmp(optname
, "amaf_prior") && optval
) {
731 /* In node policy, consider prior values
732 * part of the real result term or part
733 * of the AMAF term? */
734 u
->amaf_prior
= atoi(optval
);
736 /** Performance and memory management */
738 } else if (!strcasecmp(optname
, "threads") && optval
) {
739 /* By default, Pachi will run with only single
740 * tree search thread! */
741 u
->threads
= atoi(optval
);
742 } else if (!strcasecmp(optname
, "thread_model") && optval
) {
743 if (!strcasecmp(optval
, "tree")) {
744 /* Tree parallelization - all threads
745 * grind on the same tree. */
746 u
->thread_model
= TM_TREE
;
748 } else if (!strcasecmp(optval
, "treevl")) {
749 /* Tree parallelization, but also
750 * with virtual losses - this discou-
751 * rages most threads choosing the
752 * same tree branches to read. */
753 u
->thread_model
= TM_TREEVL
;
755 fprintf(stderr
, "UCT: Invalid thread model %s\n", optval
);
758 } else if (!strcasecmp(optname
, "virtual_loss")) {
759 /* Number of virtual losses added before evaluating a node. */
760 u
->virtual_loss
= !optval
|| atoi(optval
);
761 } else if (!strcasecmp(optname
, "pondering")) {
762 /* Keep searching even during opponent's turn. */
763 u
->pondering_opt
= !optval
|| atoi(optval
);
764 } else if (!strcasecmp(optname
, "max_tree_size") && optval
) {
765 /* Maximum amount of memory [MiB] consumed by the move tree.
766 * For fast_alloc it includes the temp tree used for pruning.
767 * Default is 3072 (3 GiB). */
768 u
->max_tree_size
= atol(optval
) * 1048576;
769 } else if (!strcasecmp(optname
, "fast_alloc")) {
770 u
->fast_alloc
= !optval
|| atoi(optval
);
771 } else if (!strcasecmp(optname
, "pruning_threshold") && optval
) {
772 /* Force pruning at beginning of a move if the tree consumes
773 * more than this [MiB]. Default is 10% of max_tree_size.
774 * Increase to reduce pruning time overhead if memory is plentiful.
775 * This option is meaningful only for fast_alloc. */
776 u
->pruning_threshold
= atol(optval
) * 1048576;
780 } else if (!strcasecmp(optname
, "best2_ratio") && optval
) {
781 /* If set, prolong simulating while
782 * first_best/second_best playouts ratio
783 * is less than best2_ratio. */
784 u
->best2_ratio
= atof(optval
);
785 } else if (!strcasecmp(optname
, "bestr_ratio") && optval
) {
786 /* If set, prolong simulating while
787 * best,best_best_child values delta
788 * is more than bestr_ratio. */
789 u
->bestr_ratio
= atof(optval
);
790 } else if (!strcasecmp(optname
, "max_maintime_ratio") && optval
) {
791 /* If set and while not in byoyomi, prolong simulating no more than
792 * max_maintime_ratio times the normal desired thinking time. */
793 u
->max_maintime_ratio
= atof(optval
);
794 } else if (!strcasecmp(optname
, "fuseki_end") && optval
) {
795 /* At the very beginning it's not worth thinking
796 * too long because the playout evaluations are
797 * very noisy. So gradually increase the thinking
798 * time up to maximum when fuseki_end percent
799 * of the board has been played.
800 * This only applies if we are not in byoyomi. */
801 u
->fuseki_end
= atoi(optval
);
802 } else if (!strcasecmp(optname
, "yose_start") && optval
) {
803 /* When yose_start percent of the board has been
804 * played, or if we are in byoyomi, stop spending
805 * more time and spread the remaining time
807 * Between fuseki_end and yose_start, we spend
808 * a constant proportion of the remaining time
809 * on each move. (yose_start should actually
810 * be much earlier than when real yose start,
811 * but "yose" is a good short name to convey
813 u
->yose_start
= atoi(optval
);
817 } else if (!strcasecmp(optname
, "dynkomi") && optval
) {
818 /* Dynamic komi approach; there are multiple
819 * ways to adjust komi dynamically throughout
820 * play. We currently support two: */
821 char *dynkomiarg
= strchr(optval
, ':');
824 if (!strcasecmp(optval
, "none")) {
825 u
->dynkomi
= uct_dynkomi_init_none(u
, dynkomiarg
, b
);
826 } else if (!strcasecmp(optval
, "linear")) {
827 /* You should set dynkomi_mask=1
828 * since this doesn't work well
829 * for white handicaps! */
830 u
->dynkomi
= uct_dynkomi_init_linear(u
, dynkomiarg
, b
);
831 } else if (!strcasecmp(optval
, "adaptive")) {
832 /* There are many more knobs to
833 * crank - see uct/dynkomi.c. */
834 u
->dynkomi
= uct_dynkomi_init_adaptive(u
, dynkomiarg
, b
);
836 fprintf(stderr
, "UCT: Invalid dynkomi mode %s\n", optval
);
839 } else if (!strcasecmp(optname
, "dynkomi_mask") && optval
) {
840 /* Bitmask of colors the player must be
841 * for dynkomi be applied; you may want
842 * to use dynkomi_mask=3 to allow dynkomi
843 * even in games where Pachi is white. */
844 u
->dynkomi_mask
= atoi(optval
);
845 } else if (!strcasecmp(optname
, "dynkomi_interval") && optval
) {
846 /* If non-zero, re-adjust dynamic komi
847 * throughout a single genmove reading,
848 * roughly every N simulations. */
849 /* XXX: Does not work with tree
850 * parallelization. */
851 u
->dynkomi_interval
= atoi(optval
);
853 /** Node value result scaling */
855 } else if (!strcasecmp(optname
, "val_scale") && optval
) {
856 /* How much of the game result value should be
857 * influenced by win size. Zero means it isn't. */
858 u
->val_scale
= atof(optval
);
859 } else if (!strcasecmp(optname
, "val_points") && optval
) {
860 /* Maximum size of win to be scaled into game
861 * result value. Zero means boardsize^2. */
862 u
->val_points
= atoi(optval
) * 2; // result values are doubled
863 } else if (!strcasecmp(optname
, "val_extra")) {
864 /* If false, the score coefficient will be simply
865 * added to the value, instead of scaling the result
866 * coefficient because of it. */
867 u
->val_extra
= !optval
|| atoi(optval
);
870 /* (Purely experimental. Does not work - yet!) */
872 } else if (!strcasecmp(optname
, "local_tree") && optval
) {
873 /* Whether to bias exploration by local tree values
874 * (must be supported by the used policy).
876 * 1: Do, value = result.
877 * Try to temper the result:
878 * 2: Do, value = 0.5+(result-expected)/2.
879 * 3: Do, value = 0.5+bzz((result-expected)^2).
880 * 4: Do, value = 0.5+sqrt(result-expected)/2. */
881 u
->local_tree
= atoi(optval
);
882 } else if (!strcasecmp(optname
, "tenuki_d") && optval
) {
883 /* Tenuki distance at which to break the local tree. */
884 u
->tenuki_d
= atoi(optval
);
885 if (u
->tenuki_d
> TREE_NODE_D_MAX
+ 1) {
886 fprintf(stderr
, "uct: tenuki_d must not be larger than TREE_NODE_D_MAX+1 %d\n", TREE_NODE_D_MAX
+ 1);
889 } else if (!strcasecmp(optname
, "local_tree_aging") && optval
) {
890 /* How much to reduce local tree values between moves. */
891 u
->local_tree_aging
= atof(optval
);
892 } else if (!strcasecmp(optname
, "local_tree_depth_decay") && optval
) {
893 /* With value x>0, during the descent the node
894 * contributes 1/x^depth playouts in
895 * the local tree. I.e., with x>1, nodes more
896 * distant from local situation contribute more
897 * than nodes near the root. */
898 u
->local_tree_depth_decay
= atof(optval
);
899 } else if (!strcasecmp(optname
, "local_tree_allseq")) {
900 /* If disabled, only complete sequences are stored
901 * in the local tree. If this is on, also
902 * subsequences starting at each move are stored. */
903 u
->local_tree_allseq
= !optval
|| atoi(optval
);
904 } else if (!strcasecmp(optname
, "local_tree_playout")) {
905 /* Whether to adjust ELO playout probability
906 * distributions according to matched localtree
908 u
->local_tree_playout
= !optval
|| atoi(optval
);
909 } else if (!strcasecmp(optname
, "local_tree_pseqroot")) {
910 /* By default, when we have no sequence move
911 * to suggest in-playout, we give up. If this
912 * is on, we make probability distribution from
913 * sequences first moves instead. */
914 u
->local_tree_pseqroot
= !optval
|| atoi(optval
);
915 } else if (!strcasecmp(optname
, "local_tree_rootseqval")) {
916 /* If disabled, expected node value is computed by
917 * summing up values through the whole descent.
918 * If enabled, expected node value for
919 * each sequence is the value at the root of the
921 u
->local_tree_rootseqval
= !optval
|| atoi(optval
);
923 /** Other heuristics */
924 } else if (!strcasecmp(optname
, "significant_threshold") && optval
) {
925 /* Some heuristics (treepool) rely
926 * on the knowledge of the last "significant"
927 * node in the descent. Such a node is
928 * considered reasonably trustworthy to carry
929 * some meaningful information in the values
930 * of the node and its children. */
931 u
->significant_threshold
= atoi(optval
);
932 } else if (!strcasecmp(optname
, "treepool_chance") && optval
) {
933 /* Chance of applying the treepool heuristic:
934 * one of the best N children of the last
935 * significant node is tried on each turn
936 * of the simulation. */
937 /* This is in form of two numbers:
938 * PREMOVE:POSTMOVE. Each is percentage
939 * value, one is the chance of the move
940 * tried before playout policy, one is the
941 * chance of it being applied if the policy
942 * has not picked anymove. */
943 char *optval2
= strchr(optval
, ':');
945 fprintf(stderr
, "uct: treepool_chance takes two comma-separated numbers\n");
948 u
->treepool_chance
[0] = atoi(optval
);
950 u
->treepool_chance
[1] = atoi(optval
);
951 } else if (!strcasecmp(optname
, "treepool_size") && optval
) {
952 /* Number of top significant children
953 * to pick from. Too low means low effect,
954 * too high means even lousy moves are
956 u
->treepool_size
= atoi(optval
);
957 } else if (!strcasecmp(optname
, "treepool_type") && optval
) {
958 /* How to sort the children. */
959 if (!strcasecmp(optval
, "rave_playouts"))
960 u
->treepool_type
= UTT_RAVE_PLAYOUTS
;
961 else if (!strcasecmp(optval
, "rave_value"))
962 u
->treepool_type
= UTT_RAVE_VALUE
;
963 else if (!strcasecmp(optval
, "uct_playouts"))
964 u
->treepool_type
= UTT_UCT_PLAYOUTS
;
965 else if (!strcasecmp(optval
, "uct_value"))
966 u
->treepool_type
= UTT_UCT_VALUE
;
967 else if (!strcasecmp(optval
, "evaluate"))
968 /* The proper combination of RAVE,
969 * UCT and prior, as used through
971 u
->treepool_type
= UTT_EVALUATE
;
973 fprintf(stderr
, "uct: unknown treepool_type %s\n", optval
);
976 } else if (!strcasecmp(optname
, "treepool_pickfactor") && optval
) {
977 /* Pick factor influencing children choice.
978 * By default (if this is 0 or 10), coords
979 * have uniform probability to be chosen;
980 * otherwise, children are tried from best
981 * to worst, each picked with probability
982 * (1/n * pickfactor/10).
983 * I.e., better children may be preferred
984 * if pickfactor > 10. */
985 u
->treepool_pickfactor
= atoi(optval
);
987 /** Distributed engine slaves setup */
989 } else if (!strcasecmp(optname
, "slave")) {
990 /* Act as slave for the distributed engine. */
991 u
->slave
= !optval
|| atoi(optval
);
992 } else if (!strcasecmp(optname
, "shared_nodes") && optval
) {
993 /* Share at most shared_nodes between master and slave at each genmoves.
994 * Must use the same value in master and slaves. */
995 u
->shared_nodes
= atoi(optval
);
996 } else if (!strcasecmp(optname
, "shared_levels") && optval
) {
997 /* Share only nodes of level <= shared_levels. */
998 u
->shared_levels
= atoi(optval
);
999 } else if (!strcasecmp(optname
, "stats_hbits") && optval
) {
1000 /* Set hash table size to 2^stats_hbits for the shared stats. */
1001 u
->stats_hbits
= atoi(optval
);
1004 fprintf(stderr
, "uct: Invalid engine argument %s or missing value\n", optname
);
1011 u
->policy
= policy_ucb1amaf_init(u
, NULL
);
1013 if (!!u
->random_policy_chance
^ !!u
->random_policy
) {
1014 fprintf(stderr
, "uct: Only one of random_policy and random_policy_chance is set\n");
1018 if (!u
->local_tree
) {
1019 /* No ltree aging. */
1020 u
->local_tree_aging
= 1.0f
;
1023 u
->local_tree_playout
= false;
1025 if (u
->fast_alloc
) {
1026 if (u
->pruning_threshold
< u
->max_tree_size
/ 10)
1027 u
->pruning_threshold
= u
->max_tree_size
/ 10;
1028 if (u
->pruning_threshold
> u
->max_tree_size
/ 2)
1029 u
->pruning_threshold
= u
->max_tree_size
/ 2;
1031 /* Limit pruning temp space to 20% of memory. Beyond this we discard
1032 * the nodes and recompute them at the next move if necessary. */
1033 u
->max_pruned_size
= u
->max_tree_size
/ 5;
1034 u
->max_tree_size
-= u
->max_pruned_size
;
1036 /* Reserve 5% memory in case the background free() are slower
1037 * than the concurrent allocations. */
1038 u
->max_tree_size
-= u
->max_tree_size
/ 20;
1042 u
->prior
= uct_prior_init(NULL
, b
);
1045 u
->playout
= playout_moggy_init(NULL
, b
, u
->jdict
);
1046 if (!u
->playout
->debug_level
)
1047 u
->playout
->debug_level
= u
->debug_level
;
1049 u
->ownermap
.map
= malloc2(board_size2(b
) * sizeof(u
->ownermap
.map
[0]));
1052 if (!u
->stats_hbits
) u
->stats_hbits
= DEFAULT_STATS_HBITS
;
1053 if (!u
->shared_nodes
) u
->shared_nodes
= DEFAULT_SHARED_NODES
;
1054 assert(u
->shared_levels
* board_bits2(b
) <= 8 * (int)sizeof(path_t
));
1058 u
->dynkomi
= uct_dynkomi_init_adaptive(u
, NULL
, b
);
1060 /* Some things remain uninitialized for now - the opening tbook
1061 * is not loaded and the tree not set up. */
1062 /* This will be initialized in setup_state() at the first move
1063 * received/requested. This is because right now we are not aware
1064 * about any komi or handicap setup and such. */
1070 engine_uct_init(char *arg
, struct board
*b
)
1072 struct uct
*u
= uct_state_init(arg
, b
);
1073 struct engine
*e
= calloc2(1, sizeof(struct engine
));
1074 e
->name
= "UCT Engine";
1075 e
->printhook
= uct_printhook_ownermap
;
1076 e
->notify_play
= uct_notify_play
;
1078 e
->result
= uct_result
;
1079 e
->genmove
= uct_genmove
;
1080 e
->genmoves
= uct_genmoves
;
1081 e
->dead_group_list
= uct_dead_group_list
;
1085 e
->notify
= uct_notify
;
1087 const char banner
[] = "I'm playing UCT. When I'm losing, I will resign, "
1088 "if I think I win, I play until you pass. "
1089 "Anyone can send me 'winrate' in private chat to get my assessment of the position.";
1090 if (!u
->banner
) u
->banner
= "";
1091 e
->comment
= malloc2(sizeof(banner
) + strlen(u
->banner
) + 1);
1092 sprintf(e
->comment
, "%s %s", banner
, u
->banner
);