git.sesse.net Git - stockfish/blob - src/evaluate.cpp

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
   4
   5   Stockfish is free software: you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation, either version 3 of the License, or
   8   (at your option) any later version.
   9
  10   Stockfish is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13   GNU General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 #include <algorithm>
  20 #include <cassert>
  21 #include <fstream>
  22 #include <iomanip>
  23 #include <sstream>
  24 #include <iostream>
  25 #include <streambuf>
  26 #include <vector>
  27
  28 #include "bitboard.h"
  29 #include "evaluate.h"
  30 #include "misc.h"
  31 #include "thread.h"
  32 #include "timeman.h"
  33 #include "uci.h"
  34 #include "incbin/incbin.h"
  35 #include "nnue/evaluate_nnue.h"
  36
  37 // Macro to embed the default efficiently updatable neural network (NNUE) file
  38 // data in the engine binary (using incbin.h, by Dale Weiler).
  39 // This macro invocation will declare the following three variables
  40 //     const unsigned char        gEmbeddedNNUEData[];  // a pointer to the embedded data
  41 //     const unsigned char *const gEmbeddedNNUEEnd;     // a marker to the end
  42 //     const unsigned int         gEmbeddedNNUESize;    // the size of the embedded file
  43 // Note that this does not work in Microsoft Visual Studio.
  44 #if !defined(_MSC_VER) && !defined(NNUE_EMBEDDING_OFF)
  45   INCBIN(EmbeddedNNUE, EvalFileDefaultName);
  46 #else
  47   const unsigned char        gEmbeddedNNUEData[1] = {0x0};
  48   const unsigned char *const gEmbeddedNNUEEnd = &gEmbeddedNNUEData[1];
  49   const unsigned int         gEmbeddedNNUESize = 1;
  50 #endif
  51
  52
  53 using namespace std;
  54
  55 namespace Stockfish {
  56
  57 namespace Eval {
  58
  59   string currentEvalFileName = "None";
  60
  61   /// NNUE::init() tries to load a NNUE network at startup time, or when the engine
  62   /// receives a UCI command "setoption name EvalFile value nn-[a-z0-9]{12}.nnue"
  63   /// The name of the NNUE network is always retrieved from the EvalFile option.
  64   /// We search the given network in three locations: internally (the default
  65   /// network may be embedded in the binary), in the active working directory and
  66   /// in the engine directory. Distro packagers may define the DEFAULT_NNUE_DIRECTORY
  67   /// variable to have the engine search in a special directory in their distro.
  68
  69   void NNUE::init() {
  70
  71     string eval_file = string(Options["EvalFile"]);
  72     if (eval_file.empty())
  73         eval_file = EvalFileDefaultName;
  74
  75     #if defined(DEFAULT_NNUE_DIRECTORY)
  76     vector<string> dirs = { "<internal>" , "" , CommandLine::binaryDirectory , stringify(DEFAULT_NNUE_DIRECTORY) };
  77     #else
  78     vector<string> dirs = { "<internal>" , "" , CommandLine::binaryDirectory };
  79     #endif
  80
  81     for (const string& directory : dirs)
  82         if (currentEvalFileName != eval_file)
  83         {
  84             if (directory != "<internal>")
  85             {
  86                 ifstream stream(directory + eval_file, ios::binary);
  87                 if (NNUE::load_eval(eval_file, stream))
  88                     currentEvalFileName = eval_file;
  89             }
  90
  91             if (directory == "<internal>" && eval_file == EvalFileDefaultName)
  92             {
  93                 // C++ way to prepare a buffer for a memory stream
  94                 class MemoryBuffer : public basic_streambuf<char> {
  95                     public: MemoryBuffer(char* p, size_t n) { setg(p, p, p + n); setp(p, p + n); }
  96                 };
  97
  98                 MemoryBuffer buffer(const_cast<char*>(reinterpret_cast<const char*>(gEmbeddedNNUEData)),
  99                                     size_t(gEmbeddedNNUESize));
 100                 (void) gEmbeddedNNUEEnd; // Silence warning on unused variable
 101
 102                 istream stream(&buffer);
 103                 if (NNUE::load_eval(eval_file, stream))
 104                     currentEvalFileName = eval_file;
 105             }
 106         }
 107   }
 108
 109   /// NNUE::verify() verifies that the last net used was loaded successfully
 110   void NNUE::verify() {
 111
 112     string eval_file = string(Options["EvalFile"]);
 113     if (eval_file.empty())
 114         eval_file = EvalFileDefaultName;
 115
 116     if (currentEvalFileName != eval_file)
 117     {
 118
 119         string msg1 = "Network evaluation parameters compatible with the engine must be available.";
 120         string msg2 = "The network file " + eval_file + " was not loaded successfully.";
 121         string msg3 = "The UCI option EvalFile might need to specify the full path, including the directory name, to the network file.";
 122         string msg4 = "The default net can be downloaded from: https://tests.stockfishchess.org/api/nn/" + std::string(EvalFileDefaultName);
 123         string msg5 = "The engine will be terminated now.";
 124
 125         sync_cout << "info string ERROR: " << msg1 << sync_endl;
 126         sync_cout << "info string ERROR: " << msg2 << sync_endl;
 127         sync_cout << "info string ERROR: " << msg3 << sync_endl;
 128         sync_cout << "info string ERROR: " << msg4 << sync_endl;
 129         sync_cout << "info string ERROR: " << msg5 << sync_endl;
 130
 131         exit(EXIT_FAILURE);
 132     }
 133
 134     sync_cout << "info string NNUE evaluation using " << eval_file << sync_endl;
 135   }
 136 }
 137
 138 /// evaluate() is the evaluator for the outer world. It returns a static
 139 /// evaluation of the position from the point of view of the side to move.
 140
 141 Value Eval::evaluate(const Position& pos) {
 142
 143   assert(!pos.checkers());
 144
 145   Value v;
 146   Value psq = pos.psq_eg_stm();
 147
 148   int nnueComplexity;
 149   int npm = pos.non_pawn_material() / 64;
 150
 151   Color stm = pos.side_to_move();
 152   Value optimism = pos.this_thread()->optimism[stm];
 153
 154   Value nnue = NNUE::evaluate(pos, true, &nnueComplexity);
 155
 156   // Blend optimism with nnue complexity and (semi)classical complexity
 157   optimism += optimism * (nnueComplexity + abs(psq - nnue)) / 512;
 158
 159   v = (  nnue     * (915 + npm + 9 * pos.count<PAWN>())
 160        + optimism * (154 + npm +     pos.count<PAWN>())) / 1024;
 161
 162   // Damp down the evaluation linearly when shuffling
 163   v = v * (200 - pos.rule50_count()) / 214;
 164
 165   // Guarantee evaluation does not hit the tablebase range
 166   v = std::clamp(v, VALUE_TB_LOSS_IN_MAX_PLY + 1, VALUE_TB_WIN_IN_MAX_PLY - 1);
 167
 168   return v;
 169 }
 170
 171 /// trace() is like evaluate(), but instead of returning a value, it returns
 172 /// a string (suitable for outputting to stdout) that contains the detailed
 173 /// descriptions and values of each evaluation term. Useful for debugging.
 174 /// Trace scores are from white's point of view
 175
 176 std::string Eval::trace(Position& pos) {
 177
 178   if (pos.checkers())
 179       return "Final evaluation: none (in check)";
 180
 181   // Reset any global variable used in eval
 182   pos.this_thread()->bestValue       = VALUE_ZERO;
 183   pos.this_thread()->optimism[WHITE] = VALUE_ZERO;
 184   pos.this_thread()->optimism[BLACK] = VALUE_ZERO;
 185
 186   std::stringstream ss;
 187   ss << std::showpoint << std::noshowpos << std::fixed << std::setprecision(2);
 188   ss << '\n' << NNUE::trace(pos) << '\n';
 189
 190   ss << std::showpoint << std::showpos << std::fixed << std::setprecision(2) << std::setw(15);
 191
 192   Value v;
 193   v = NNUE::evaluate(pos, false);
 194   v = pos.side_to_move() == WHITE ? v : -v;
 195   ss << "NNUE evaluation        " << 0.01 * UCI::to_cp(v) << " (white side)\n";
 196
 197   v = evaluate(pos);
 198   v = pos.side_to_move() == WHITE ? v : -v;
 199   ss << "Final evaluation       " << 0.01 * UCI::to_cp(v) << " (white side)";
 200   ss << " [with scaled NNUE, ...]";
 201   ss << "\n";
 202
 203   return ss.str();
 204 }
 205
 206 } // namespace Stockfish