- added UCI option Game_Phase_Definition with options "lichess" and "…

…movecount" and corresponding searchsettings enum GamePhaseDefinition
QueensGambit · QueensGambit · May 3, 2024 · Jun 22, 2023 · Jun 22, 2023 · Jun 24, 2023
commit fa3dfe628206cb73bda13e1385bf4e4cb379ec07
diff --git a/engine/src/agents/config/searchsettings.cpp b/engine/src/agents/config/searchsettings.cpp
@@ -51,7 +51,8 @@ SearchSettings::SearchSettings():
         searchPlayerMode(MODE_TWO_PLAYER),
         virtualStyle(VIRTUAL_VISIT),
         virtualMixThreshold(1000),
-        virtualOffsetStrenght(0.001)
+        virtualOffsetStrenght(0.001),
+        gamePhaseDefinition(MOVECOUNT)
 {
 
 }
diff --git a/engine/src/agents/config/searchsettings.h b/engine/src/agents/config/searchsettings.h
@@ -43,6 +43,11 @@ enum VirtualStyle {
     VIRTUAL_MIX
 };
 
+enum GamePhaseDefinition {
+    LICHESS,
+    MOVECOUNT
+};
+
 struct SearchSettings
 {
     uint16_t multiPV;
@@ -87,6 +92,8 @@ struct SearchSettings
     uint_fast32_t virtualMixThreshold;
     // Defines the strength of the virtual offset
     double virtualOffsetStrenght;
+    // Defines the type of game phase definition to be used
+    GamePhaseDefinition gamePhaseDefinition;
     SearchSettings();
 
 };

diff --git a/engine/src/agents/mctsagent.cpp b/engine/src/agents/mctsagent.cpp
@@ -170,7 +170,7 @@ shared_ptr<Node> MCTSAgent::get_root_node_from_tree(StateObj *state)
 void MCTSAgent::set_root_node_predictions()
 {
     state->get_state_planes(true, inputPlanes, nets.front()->get_version());
-    GamePhase currentPhase = state->get_phase(numPhases);
+    GamePhase currentPhase = state->get_phase(numPhases, searchSettings->gamePhaseDefinition);
     nets[phaseToNetsIndex.at(currentPhase)]->predict(inputPlanes, valueOutputs, probOutputs, auxiliaryOutputs);
     size_t tbHits = 0;
     fill_nn_results(0, nets[phaseToNetsIndex.at(currentPhase)]->is_policy_map(), valueOutputs, probOutputs, auxiliaryOutputs, rootNode.get(), tbHits,

diff --git a/engine/src/agents/rawnetagent.cpp b/engine/src/agents/rawnetagent.cpp
@@ -54,7 +54,8 @@ void RawNetAgent::evaluate_board_state()
         return;
     }
     state->get_state_planes(true, inputPlanes, nets.front()->get_version());
-    nets[phaseToNetsIndex.at(state->get_phase(numPhases))]->predict(inputPlanes, valueOutputs, probOutputs, auxiliaryOutputs);
+    // TODO: currently always uses MOVECOUNT as GamePhaseDefinition because RawNetAgent has no SearchSettings available
+    nets[phaseToNetsIndex.at(state->get_phase(numPhases, MOVECOUNT))]->predict(inputPlanes, valueOutputs, probOutputs, auxiliaryOutputs);
     state->set_auxiliary_outputs(auxiliaryOutputs);
 
     evalInfo->policyProbSmall.resize(evalInfo->legalMoves.size());

diff --git a/engine/src/environments/chess_related/board.cpp b/engine/src/environments/chess_related/board.cpp
@@ -537,10 +537,12 @@ int get_mixedness(const Board& pos)
     return mix;
 }
 
-GamePhase Board::get_phase(unsigned int numPhases) const
+GamePhase Board::get_phase(unsigned int numPhases, GamePhaseDefinition gamePhaseDefinition) const
 {
-    if (numPhases == 3 && true) {
-        // currently enabled so that trivial phases by move count are not used if numPhases == 3
+    if (gamePhaseDefinition == LICHESS) {
+
+        assert(numPhases == 3);  // lichess definition requires three models to be loaded
+
         // returns the game phase based on the lichess definition implemented in:
         // https://github.com/lichess-org/scalachess/blob/master/src/main/scala/Divider.scala
         unsigned int numMajorsAndMinors = get_majors_and_minors_count(*this);
@@ -564,19 +566,21 @@ GamePhase Board::get_phase(unsigned int numPhases) const
             }
         }
     }
-    if (numPhases == 1) {
-        return GamePhase(0);
-    }
-    else {  // use naive phases by move count
-        double averageMovecountPerGame = 42.85;
-        double phaseLength = std::round(averageMovecountPerGame / numPhases);
-        size_t movesCompleted = this->total_move_cout();
-        double gamePhaseDouble = movesCompleted / phaseLength;
-        if (gamePhaseDouble > numPhases - 1){ // ensure that all higher results are attributed to the last phase
-            return GamePhase(numPhases - 1);
+    else if (gamePhaseDefinition == MOVECOUNT) {
+        if (numPhases == 1) { // directly return phase 0 if there is only a single network loaded
+            return GamePhase(0);
         }
-        else {
-            return GamePhase(gamePhaseDouble); // truncated to Integer value
+        else {  // use naive phases by move count
+            double averageMovecountPerGame = 42.85;
+            double phaseLength = std::round(averageMovecountPerGame / numPhases);
+            size_t movesCompleted = this->total_move_cout();
+            double gamePhaseDouble = movesCompleted / phaseLength;
+            if (gamePhaseDouble > numPhases - 1) { // ensure that all higher results are attributed to the last phase
+                return GamePhase(numPhases - 1);
+            }
+            else {
+                return GamePhase(gamePhaseDouble); // truncated to Integer value
+            }
         }
     }
 }
diff --git a/engine/src/environments/chess_related/board.h b/engine/src/environments/chess_related/board.h
@@ -119,12 +119,13 @@ class Board : public Position
     bool draw_by_insufficient_material() const;
 
     /**
-     * @brief get_phase Returns the game phase of the current board state based on the total amount of phases
+     * @brief get_phase Returns the game phase of the current board state based on the total amount of phases and the chosen GamePhaseDefinition
      * Possible returned values are all integers from 0 to numPhases - 1
      * @param unsigned int numPhases
+     * @param GamePhaseDefinition gamePhaseDefinition
      * @return Game phase as unsigned int
      */
-    GamePhase get_phase(unsigned int numPhases) const;
+    GamePhase get_phase(unsigned int numPhases, GamePhaseDefinition gamePhaseDefinition) const;
 
     // overloaded function which include a last move list update
     void do_move(Move m, StateInfo& newSt);

diff --git a/engine/src/environments/chess_related/boardstate.cpp b/engine/src/environments/chess_related/boardstate.cpp
@@ -272,7 +272,7 @@ void BoardState::init(int variant, bool is960)
 
 #endif
 
-GamePhase BoardState::get_phase(unsigned int numPhases) const
+GamePhase BoardState::get_phase(unsigned int numPhases, GamePhaseDefinition gamePhaseDefinition) const
 {
-    return board.get_phase(numPhases);
+    return board.get_phase(numPhases, gamePhaseDefinition);
 }
diff --git a/engine/src/environments/chess_related/boardstate.h b/engine/src/environments/chess_related/boardstate.h
@@ -417,7 +417,7 @@ class BoardState : public State
     void set_auxiliary_outputs(const float* auxiliaryOutputs) override;
     BoardState* clone() const override;
     void init(int variant, bool isChess960) override;
-    GamePhase get_phase(unsigned int numPhases) const;
+    GamePhase get_phase(unsigned int numPhases, GamePhaseDefinition gamePhaseDefinition) const;
 };
 
 #endif // BOARTSTATE_H

diff --git a/engine/src/searchthread.cpp b/engine/src/searchthread.cpp
@@ -227,7 +227,7 @@ Node* SearchThread::get_new_child_to_evaluate(NodeDescription& description)
                 // fill a new board in the input_planes vector
                 // we shift the index by nbNNInputValues each time
                 newState->get_state_planes(true, inputPlanes + newNodes->size() * nets.front()->get_nb_input_values_total(), nets.front()->get_version());
-                GamePhase currPhase = newState->get_phase(numPhases);
+                GamePhase currPhase = newState->get_phase(numPhases, searchSettings->gamePhaseDefinition);
                 phaseCountMap[currPhase]++;
                 // save a reference newly created list in the temporary list for node creation
                 // it will later be updated with the evaluation of the NN

diff --git a/engine/src/state.h b/engine/src/state.h
@@ -35,6 +35,7 @@
 #include <memory>
 #include "version.h"
 #include "util/communication.h"
+#include "agents/config/searchsettings.h"
 
 typedef uint64_t Key;
 #ifdef ACTION_64_BIT

diff --git a/engine/src/uci/crazyara.cpp b/engine/src/uci/crazyara.cpp
@@ -773,6 +773,15 @@ void CrazyAra::init_search_settings()
         info_string_important("Unknown option", Options["Virtual_Style"], "for Virtual_Style");
     }
     searchSettings.virtualMixThreshold = Options["Virtual_Mix_Threshold"];
+    if (Options["Game_Phase_Definition"] == "lichess") {
+        searchSettings.gamePhaseDefinition = LICHESS;
+    }
+    else if (Options["Game_Phase_Definition"] == "movecount") {
+        searchSettings.gamePhaseDefinition = MOVECOUNT;
+    }
+    else {
+        info_string_important("Unknown option", Options["Game_Phase_Definition"], "for Game_Phase_Definition");
+    }
 }
 
 void CrazyAra::init_play_settings()

diff --git a/engine/src/uci/optionsuci.cpp b/engine/src/uci/optionsuci.cpp
@@ -193,6 +193,7 @@ void OptionsUCI::init(OptionsMap &o)
     o["Use_Raw_Network"]               << Option(false);
     o["Virtual_Style"]                 << Option("virtual_mix", { "virtual_loss", "virtual_visit", "virtual_offset", "virtual_mix" });
     o["Virtual_Mix_Threshold"]         << Option(1000, 1, 99999999);
+    o["Game_Phase_Definition"]         << Option("movecount", { "lichess", "movecount"});
     // additional UCI-Options for RL only
 #ifdef USE_RL
     o["Centi_Node_Random_Factor"]      << Option(10, 0, 100);