1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
use crate::*;
/// A game record to be analyzed, along with analysis settings.
#[derive(Debug, Clone)]
pub struct AnalysisRequest {
/// The ruleset for this game.
pub rules: Rules,
/// The komi for this game.
pub komi: Option<f64>,
/// Bonus points white receives in handicap games.
pub white_handicap_bonus: Option<Bonus>,
/// The board width.
pub board_x_size: u8,
/// The board height.
pub board_y_size: u8,
/// The stones on the board before the first move.
pub initial_stones: Option<Vec<(Player, Coord)>>,
/// The player to move in the initial position.
pub initial_player: Option<Player>,
/// The moves played in the game.
pub moves: Vec<(Player, Move)>,
/// The maximum number of visits to use.
pub max_visits: Option<u32>,
/// Root policy temperature.
pub root_policy_temperature: Option<f64>,
/// Root FPU reduction max.
pub root_fpu_reduction_max: Option<f64>,
/// The maximum length of the principal variation to return, not including the first move.
pub analysis_pv_len: Option<usize>,
/// Whether to return the ownership prediction.
pub include_ownership: bool,
/// Whether to return the standard deviation of the ownership prediction.
pub include_ownership_stdev: bool,
/// Whether to return the ownership prediction for each move.
pub include_moves_ownership: bool,
/// Whether to return the standard deviation of the ownership prediction for each move.
pub include_moves_ownership_stdev: bool,
/// Whether to return the neural network policy output.
pub include_policy: bool,
/// Whether to return the number of visits for each position in the principal variation.
pub include_pv_visits: bool,
/// Whether to return the predicted probability that the game will have a void result.
pub include_no_result_value: bool,
/// Moves which are forbidden.
pub avoid_moves: Option<Vec<RestrictedMoves>>,
/// Moves which are allowed. If specified, all other moves are forbidden.
pub allow_moves: Option<Vec<RestrictedMoves>>,
/// Config overrides for this request.
pub override_settings: Option<Config>,
/// Report partial analysis results every this many seconds.
pub report_during_search_every: Option<f64>,
/// The priority of this request.
pub priority: Option<i32>,
}
impl AnalysisRequest {
/// Creates a new analysis request with the minimum required parameters.
pub fn new(
rules: Rules,
board_x_size: u8,
board_y_size: u8,
moves: Vec<(Player, Move)>,
) -> Self {
Self {
rules,
komi: None,
white_handicap_bonus: None,
board_x_size,
board_y_size,
initial_stones: None,
initial_player: None,
moves,
max_visits: None,
root_policy_temperature: None,
root_fpu_reduction_max: None,
analysis_pv_len: None,
include_ownership: false,
include_ownership_stdev: false,
include_moves_ownership: false,
include_moves_ownership_stdev: false,
include_policy: false,
include_pv_visits: false,
include_no_result_value: false,
avoid_moves: None,
allow_moves: None,
override_settings: None,
report_during_search_every: None,
priority: None,
}
}
/// Converts this request into the lower-level equivalent used by the [`engine`] module.
///
/// You probably don't need to use this unless you're directly using the lower-level API in the [`engine`] module.
pub fn into_engine_request(
self,
id: String,
analyze_turns: Vec<usize>,
priorities: Option<Vec<i32>>,
) -> engine::AnalysisRequest {
engine::AnalysisRequest {
id,
rules: self.rules,
komi: self.komi,
white_handicap_bonus: self.white_handicap_bonus,
board_x_size: self.board_x_size,
board_y_size: self.board_y_size,
initial_stones: self.initial_stones.map(|s| {
s.into_iter()
.map(|(p, c)| (p, c.to_gtp(self.board_y_size)))
.collect()
}),
initial_player: self.initial_player,
moves: self
.moves
.into_iter()
.map(|(p, m)| (p, m.to_gtp(self.board_y_size)))
.collect(),
analyze_turns: Some(analyze_turns),
max_visits: self.max_visits,
root_policy_temperature: self.root_policy_temperature,
root_fpu_reduction_max: self.root_fpu_reduction_max,
analysis_pv_len: self.analysis_pv_len,
include_ownership: self.include_ownership,
include_ownership_stdev: self.include_ownership_stdev,
include_moves_ownership: self.include_moves_ownership,
include_moves_ownership_stdev: self.include_moves_ownership_stdev,
include_policy: self.include_policy,
include_pv_visits: self.include_pv_visits,
include_no_result_value: self.include_no_result_value,
avoid_moves: self.avoid_moves.map(|m| {
m.into_iter()
.map(|rm| rm.into_engine_restricted_moves(self.board_y_size))
.collect()
}),
allow_moves: self.allow_moves.map(|m| {
m.into_iter()
.map(|rm| rm.into_engine_restricted_moves(self.board_y_size))
.collect()
}),
override_settings: self.override_settings,
report_during_search_every: self.report_during_search_every,
priority: self.priority,
priorities,
}
}
/// Sets komi.
pub fn with_komi(mut self, komi: f64) -> Self {
self.komi = Some(komi);
self
}
/// Sets white's handicap bonus.
pub fn with_white_handicap_bonus(mut self, bonus: Bonus) -> Self {
self.white_handicap_bonus = Some(bonus);
self
}
/// Sets the initial position before the first move.
pub fn with_initial_stones(mut self, initial_stones: Vec<(Player, Coord)>) -> Self {
self.initial_stones = Some(initial_stones);
self
}
/// Sets the player to move in the initial position.
pub fn with_initial_player(mut self, initial_player: Player) -> Self {
self.initial_player = Some(initial_player);
self
}
/// Sets the maximum number of visits to use.
pub fn with_max_visits(mut self, max_visits: u32) -> Self {
self.max_visits = Some(max_visits);
self
}
/// Sets the root policy temperature.
pub fn with_root_policy_temperature(mut self, root_policy_temperature: f64) -> Self {
self.root_policy_temperature = Some(root_policy_temperature);
self
}
/// Sets the root FPU reduction max.
pub fn with_root_fpu_reduction_max(mut self, root_fpu_reduction_max: f64) -> Self {
self.root_fpu_reduction_max = Some(root_fpu_reduction_max);
self
}
/// Sets the maximum length of the principal variation to return, not including the first move.
pub fn with_analysis_pv_len(mut self, analysis_pv_len: usize) -> Self {
self.analysis_pv_len = Some(analysis_pv_len);
self
}
/// Includes the ownership prediction.
pub fn with_ownership(mut self) -> Self {
self.include_ownership = true;
self
}
/// Includes the standard deviation of the ownership prediction.
pub fn with_ownership_stdev(mut self) -> Self {
self.include_ownership_stdev = true;
self
}
/// Includes the ownership prediction for each move.
pub fn with_moves_ownership(mut self) -> Self {
self.include_moves_ownership = true;
self
}
/// Includes the standard deviation of the ownership prediction for each move.
pub fn with_moves_ownership_stdev(mut self) -> Self {
self.include_moves_ownership_stdev = true;
self
}
/// Includes the neural network policy output.
pub fn with_policy(mut self) -> Self {
self.include_policy = true;
self
}
/// Includes the number of visits for each position in the principal variation.
pub fn with_pv_visits(mut self) -> Self {
self.include_pv_visits = true;
self
}
/// Includes the predicted probability that the game will have a void result.
pub fn with_no_result_value(mut self) -> Self {
self.include_no_result_value = true;
self
}
/// Sets moves which are forbidden.
pub fn with_avoid_moves(mut self, avoid_moves: Vec<RestrictedMoves>) -> Self {
self.avoid_moves = Some(avoid_moves);
self
}
/// Sets moves which are allowed.
pub fn with_allow_moves(mut self, allow_moves: Vec<RestrictedMoves>) -> Self {
self.allow_moves = Some(allow_moves);
self
}
/// Overrides config settings for this request.
pub fn with_override_settings(mut self, config: Config) -> Self {
self.override_settings = Some(config);
self
}
/// Gets partial analysis results every this many seconds.
pub fn with_report_during_search_every(mut self, seconds: f64) -> Self {
self.report_during_search_every = Some(seconds);
self
}
/// Sets the priority of this request.
pub fn with_priority(mut self, priority: i32) -> Self {
self.priority = Some(priority);
self
}
}
/// A list of moves that are either forbidden with [`AnalysisRequest::avoid_moves`] or allowed with
/// [`AnalysisRequest::allow_moves`].
#[derive(Debug, Clone)]
pub struct RestrictedMoves {
/// The player the move restriction applies to.
pub player: Player,
/// The list of moves.
pub moves: Vec<Move>,
/// The search depth within which the restriction applies.
pub until_depth: u32,
}
impl RestrictedMoves {
/// Converts this restriction into the lower-level equivalent used by the [`engine`] module.
///
/// You probably don't need to use this unless you're directly using the lower-level API in the [`engine`] module.
pub fn into_engine_restricted_moves(self, height: u8) -> engine::RestrictedMoves {
engine::RestrictedMoves {
player: self.player,
moves: self.moves.into_iter().map(|m| m.to_gtp(height)).collect(),
until_depth: self.until_depth,
}
}
}