From 6772abe6645d870fc0425984d02e68e591dd5f0d Mon Sep 17 00:00:00 2001 From: Carsten Wenderdel Date: Sun, 3 Nov 2024 12:13:10 +0100 Subject: [PATCH] Remove obsolete documentation about `GameOverEvaluator` --- crates/engine/src/evaluator.rs | 3 +-- docs/dev/engine.md | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/crates/engine/src/evaluator.rs b/crates/engine/src/evaluator.rs index 14f1490..af0a21d 100644 --- a/crates/engine/src/evaluator.rs +++ b/crates/engine/src/evaluator.rs @@ -3,8 +3,7 @@ use crate::position::Position; use crate::probabilities::Probabilities; /// [Evaluator] is one of the central parts of the engine. Implementing structs only have to -/// implement the function [Evaluator::eval], Examples are [crate::composite::GameOverEvaluator] -/// and `RolloutEvaluator`. +/// implement the function [Evaluator::eval], Examples are `OnnxEvaluator` and `RolloutEvaluator`. /// /// The function [Evaluator::eval_batch] is implemented by default, building on `eval`. /// If there is way to optimize evaluations by looking at all legal moves at once, then don't diff --git a/docs/dev/engine.md b/docs/dev/engine.md index aa8ef48..a470f81 100644 --- a/docs/dev/engine.md +++ b/docs/dev/engine.md @@ -41,9 +41,9 @@ For a given position in cubeless money game, it returns the probabilities to win https://github.com/carsten-wenderdel/wildbg/blob/d5c7280a60a52cb61c92af78018fb811cf3dd223/crates/engine/src/evaluator.rs#L31 Examples of implementations are -- `GameOverEvaluator` for positions where the game is over and the probabilities are known. + - `OnnxEvaluator` which uses a neural net in `ONNX` format to calculate the probabilities. -- `CompositeEvaluator` which consists of a `GameOverEvaluator` and other evaluators for different game phases. It decides which evaluator to use based on the position. +- `CompositeEvaluator` which consists of various `OnnxEvaluator`s for different game phases. - `RolloutEvaluator` which uses another evaluator to do rollouts. ## Inputs generation