git.sesse.net Git - stockfish/blob - src/nnue/evaluate_nnue.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 // Code for calculating NNUE evaluation function
  20
  21 #include <fstream>
  22 #include <iomanip>
  23 #include <iostream>
  24 #include <set>
  25 #include <sstream>
  26 #include <string_view>
  27
  28 #include "../evaluate.h"
  29 #include "../position.h"
  30 #include "../uci.h"
  31 #include "../types.h"
  32
  33 #include "evaluate_nnue.h"
  34
  35 namespace Stockfish::Eval::NNUE {
  36
  37   // Input feature converter
  38   LargePagePtr<FeatureTransformer> featureTransformer;
  39
  40   // Evaluation function
  41   AlignedPtr<Network> network[LayerStacks];
  42
  43   // Evaluation function file name
  44   std::string fileName;
  45   std::string netDescription;
  46
  47   namespace Detail {
  48
  49   // Initialize the evaluation function parameters
  50   template <typename T>
  51   void initialize(AlignedPtr<T>& pointer) {
  52
  53     pointer.reset(reinterpret_cast<T*>(std_aligned_alloc(alignof(T), sizeof(T))));
  54     std::memset(pointer.get(), 0, sizeof(T));
  55   }
  56
  57   template <typename T>
  58   void initialize(LargePagePtr<T>& pointer) {
  59
  60     static_assert(alignof(T) <= 4096, "aligned_large_pages_alloc() may fail for such a big alignment requirement of T");
  61     pointer.reset(reinterpret_cast<T*>(aligned_large_pages_alloc(sizeof(T))));
  62     std::memset(pointer.get(), 0, sizeof(T));
  63   }
  64
  65   // Read evaluation function parameters
  66   template <typename T>
  67   bool read_parameters(std::istream& stream, T& reference) {
  68
  69     std::uint32_t header;
  70     header = read_little_endian<std::uint32_t>(stream);
  71     if (!stream || header != T::get_hash_value()) return false;
  72     return reference.read_parameters(stream);
  73   }
  74
  75   // Write evaluation function parameters
  76   template <typename T>
  77   bool write_parameters(std::ostream& stream, const T& reference) {
  78
  79     write_little_endian<std::uint32_t>(stream, T::get_hash_value());
  80     return reference.write_parameters(stream);
  81   }
  82
  83   }  // namespace Detail
  84
  85   // Initialize the evaluation function parameters
  86   static void initialize() {
  87
  88     Detail::initialize(featureTransformer);
  89     for (std::size_t i = 0; i < LayerStacks; ++i)
  90       Detail::initialize(network[i]);
  91   }
  92
  93   // Read network header
  94   static bool read_header(std::istream& stream, std::uint32_t* hashValue, std::string* desc)
  95   {
  96     std::uint32_t version, size;
  97
  98     version     = read_little_endian<std::uint32_t>(stream);
  99     *hashValue  = read_little_endian<std::uint32_t>(stream);
 100     size        = read_little_endian<std::uint32_t>(stream);
 101     if (!stream || version != Version) return false;
 102     desc->resize(size);
 103     stream.read(&(*desc)[0], size);
 104     return !stream.fail();
 105   }
 106
 107   // Write network header
 108   static bool write_header(std::ostream& stream, std::uint32_t hashValue, const std::string& desc)
 109   {
 110     write_little_endian<std::uint32_t>(stream, Version);
 111     write_little_endian<std::uint32_t>(stream, hashValue);
 112     write_little_endian<std::uint32_t>(stream, (std::uint32_t)desc.size());
 113     stream.write(&desc[0], desc.size());
 114     return !stream.fail();
 115   }
 116
 117   // Read network parameters
 118   static bool read_parameters(std::istream& stream) {
 119
 120     std::uint32_t hashValue;
 121     if (!read_header(stream, &hashValue, &netDescription)) return false;
 122     if (hashValue != HashValue) return false;
 123     if (!Detail::read_parameters(stream, *featureTransformer)) return false;
 124     for (std::size_t i = 0; i < LayerStacks; ++i)
 125       if (!Detail::read_parameters(stream, *(network[i]))) return false;
 126     return stream && stream.peek() == std::ios::traits_type::eof();
 127   }
 128
 129   // Write network parameters
 130   static bool write_parameters(std::ostream& stream) {
 131
 132     if (!write_header(stream, HashValue, netDescription)) return false;
 133     if (!Detail::write_parameters(stream, *featureTransformer)) return false;
 134     for (std::size_t i = 0; i < LayerStacks; ++i)
 135       if (!Detail::write_parameters(stream, *(network[i]))) return false;
 136     return (bool)stream;
 137   }
 138
 139   // Evaluation function. Perform differential calculation.
 140   Value evaluate(const Position& pos, bool adjusted, int* complexity) {
 141
 142     // We manually align the arrays on the stack because with gcc < 9.3
 143     // overaligning stack variables with alignas() doesn't work correctly.
 144
 145     constexpr uint64_t alignment = CacheLineSize;
 146     int delta = 24 - pos.non_pawn_material() / 9560;
 147
 148 #if defined(ALIGNAS_ON_STACK_VARIABLES_BROKEN)
 149     TransformedFeatureType transformedFeaturesUnaligned[
 150       FeatureTransformer::BufferSize + alignment / sizeof(TransformedFeatureType)];
 151
 152     auto* transformedFeatures = align_ptr_up<alignment>(&transformedFeaturesUnaligned[0]);
 153 #else
 154     alignas(alignment)
 155       TransformedFeatureType transformedFeatures[FeatureTransformer::BufferSize];
 156 #endif
 157
 158     ASSERT_ALIGNED(transformedFeatures, alignment);
 159
 160     const int bucket = (pos.count<ALL_PIECES>() - 1) / 4;
 161     const auto psqt = featureTransformer->transform(pos, transformedFeatures, bucket);
 162     const auto positional = network[bucket]->propagate(transformedFeatures);
 163
 164     if (complexity)
 165         *complexity = abs(psqt - positional) / OutputScale;
 166
 167     // Give more value to positional evaluation when adjusted flag is set
 168     if (adjusted)
 169         return static_cast<Value>(((1024 - delta) * psqt + (1024 + delta) * positional) / (1024 * OutputScale));
 170     else
 171         return static_cast<Value>((psqt + positional) / OutputScale);
 172   }
 173
 174   struct NnueEvalTrace {
 175     static_assert(LayerStacks == PSQTBuckets);
 176
 177     Value psqt[LayerStacks];
 178     Value positional[LayerStacks];
 179     std::size_t correctBucket;
 180   };
 181
 182   static NnueEvalTrace trace_evaluate(const Position& pos) {
 183
 184     // We manually align the arrays on the stack because with gcc < 9.3
 185     // overaligning stack variables with alignas() doesn't work correctly.
 186
 187     constexpr uint64_t alignment = CacheLineSize;
 188
 189 #if defined(ALIGNAS_ON_STACK_VARIABLES_BROKEN)
 190     TransformedFeatureType transformedFeaturesUnaligned[
 191       FeatureTransformer::BufferSize + alignment / sizeof(TransformedFeatureType)];
 192
 193     auto* transformedFeatures = align_ptr_up<alignment>(&transformedFeaturesUnaligned[0]);
 194 #else
 195     alignas(alignment)
 196       TransformedFeatureType transformedFeatures[FeatureTransformer::BufferSize];
 197 #endif
 198
 199     ASSERT_ALIGNED(transformedFeatures, alignment);
 200
 201     NnueEvalTrace t{};
 202     t.correctBucket = (pos.count<ALL_PIECES>() - 1) / 4;
 203     for (IndexType bucket = 0; bucket < LayerStacks; ++bucket) {
 204       const auto materialist = featureTransformer->transform(pos, transformedFeatures, bucket);
 205       const auto positional = network[bucket]->propagate(transformedFeatures);
 206
 207       t.psqt[bucket] = static_cast<Value>( materialist / OutputScale );
 208       t.positional[bucket] = static_cast<Value>( positional / OutputScale );
 209     }
 210
 211     return t;
 212   }
 213
 214   constexpr std::string_view PieceToChar(" PNBRQK  pnbrqk");
 215
 216
 217   // format_cp_compact() converts a Value into (centi)pawns and writes it in a buffer.
 218   // The buffer must have capacity for at least 5 chars.
 219   static void format_cp_compact(Value v, char* buffer) {
 220
 221     buffer[0] = (v < 0 ? '-' : v > 0 ? '+' : ' ');
 222
 223     int cp = std::abs(100 * v / UCI::NormalizeToPawnValue);
 224     if (cp >= 10000)
 225     {
 226         buffer[1] = '0' + cp / 10000; cp %= 10000;
 227         buffer[2] = '0' + cp / 1000; cp %= 1000;
 228         buffer[3] = '0' + cp / 100;
 229         buffer[4] = ' ';
 230     }
 231     else if (cp >= 1000)
 232     {
 233         buffer[1] = '0' + cp / 1000; cp %= 1000;
 234         buffer[2] = '0' + cp / 100; cp %= 100;
 235         buffer[3] = '.';
 236         buffer[4] = '0' + cp / 10;
 237     }
 238     else
 239     {
 240         buffer[1] = '0' + cp / 100; cp %= 100;
 241         buffer[2] = '.';
 242         buffer[3] = '0' + cp / 10; cp %= 10;
 243         buffer[4] = '0' + cp / 1;
 244     }
 245   }
 246
 247
 248   // format_cp_aligned_dot() converts a Value into (centi)pawns, always keeping two decimals.
 249   static void format_cp_aligned_dot(Value v, std::stringstream &stream) {
 250     const double cp = 1.0 * std::abs(int(v)) / UCI::NormalizeToPawnValue;
 251
 252     stream << (v < 0 ? '-' : v > 0 ? '+' : ' ')
 253            << std::setiosflags(std::ios::fixed)
 254            << std::setw(6)
 255            << std::setprecision(2)
 256            << cp;
 257   }
 258
 259
 260   // trace() returns a string with the value of each piece on a board,
 261   // and a table for (PSQT, Layers) values bucket by bucket.
 262
 263   std::string trace(Position& pos) {
 264
 265     std::stringstream ss;
 266
 267     char board[3*8+1][8*8+2];
 268     std::memset(board, ' ', sizeof(board));
 269     for (int row = 0; row < 3*8+1; ++row)
 270       board[row][8*8+1] = '\0';
 271
 272     // A lambda to output one box of the board
 273     auto writeSquare = [&board](File file, Rank rank, Piece pc, Value value) {
 274
 275       const int x = ((int)file) * 8;
 276       const int y = (7 - (int)rank) * 3;
 277       for (int i = 1; i < 8; ++i)
 278          board[y][x+i] = board[y+3][x+i] = '-';
 279       for (int i = 1; i < 3; ++i)
 280          board[y+i][x] = board[y+i][x+8] = '|';
 281       board[y][x] = board[y][x+8] = board[y+3][x+8] = board[y+3][x] = '+';
 282       if (pc != NO_PIECE)
 283         board[y+1][x+4] = PieceToChar[pc];
 284       if (value != VALUE_NONE)
 285         format_cp_compact(value, &board[y+2][x+2]);
 286     };
 287
 288     // We estimate the value of each piece by doing a differential evaluation from
 289     // the current base eval, simulating the removal of the piece from its square.
 290     Value base = evaluate(pos);
 291     base = pos.side_to_move() == WHITE ? base : -base;
 292
 293     for (File f = FILE_A; f <= FILE_H; ++f)
 294       for (Rank r = RANK_1; r <= RANK_8; ++r)
 295       {
 296         Square sq = make_square(f, r);
 297         Piece pc = pos.piece_on(sq);
 298         Value v = VALUE_NONE;
 299
 300         if (pc != NO_PIECE && type_of(pc) != KING)
 301         {
 302           auto st = pos.state();
 303
 304           pos.remove_piece(sq);
 305           st->accumulator.computed[WHITE] = false;
 306           st->accumulator.computed[BLACK] = false;
 307
 308           Value eval = evaluate(pos);
 309           eval = pos.side_to_move() == WHITE ? eval : -eval;
 310           v = base - eval;
 311
 312           pos.put_piece(pc, sq);
 313           st->accumulator.computed[WHITE] = false;
 314           st->accumulator.computed[BLACK] = false;
 315         }
 316
 317         writeSquare(f, r, pc, v);
 318       }
 319
 320     ss << " NNUE derived piece values:\n";
 321     for (int row = 0; row < 3*8+1; ++row)
 322         ss << board[row] << '\n';
 323     ss << '\n';
 324
 325     auto t = trace_evaluate(pos);
 326
 327     ss << " NNUE network contributions "
 328        << (pos.side_to_move() == WHITE ? "(White to move)" : "(Black to move)") << std::endl
 329        << "+------------+------------+------------+------------+\n"
 330        << "|   Bucket   |  Material  | Positional |   Total    |\n"
 331        << "|            |   (PSQT)   |  (Layers)  |            |\n"
 332        << "+------------+------------+------------+------------+\n";
 333
 334     for (std::size_t bucket = 0; bucket < LayerStacks; ++bucket)
 335     {
 336       ss <<  "|  " << bucket    << "        ";
 337       ss << " |  "; format_cp_aligned_dot(t.psqt[bucket], ss); ss << "  "
 338          << " |  "; format_cp_aligned_dot(t.positional[bucket], ss); ss << "  "
 339          << " |  "; format_cp_aligned_dot(t.psqt[bucket] + t.positional[bucket], ss); ss << "  "
 340          << " |";
 341       if (bucket == t.correctBucket)
 342           ss << " <-- this bucket is used";
 343       ss << '\n';
 344     }
 345
 346     ss << "+------------+------------+------------+------------+\n";
 347
 348     return ss.str();
 349   }
 350
 351
 352   // Load eval, from a file stream or a memory stream
 353   bool load_eval(std::string name, std::istream& stream) {
 354
 355     initialize();
 356     fileName = name;
 357     return read_parameters(stream);
 358   }
 359
 360   // Save eval, to a file stream or a memory stream
 361   bool save_eval(std::ostream& stream) {
 362
 363     if (fileName.empty())
 364       return false;
 365
 366     return write_parameters(stream);
 367   }
 368
 369   /// Save eval, to a file given by its name
 370   bool save_eval(const std::optional<std::string>& filename) {
 371
 372     std::string actualFilename;
 373     std::string msg;
 374
 375     if (filename.has_value())
 376         actualFilename = filename.value();
 377     else
 378     {
 379         if (currentEvalFileName != EvalFileDefaultName)
 380         {
 381              msg = "Failed to export a net. A non-embedded net can only be saved if the filename is specified";
 382
 383              sync_cout << msg << sync_endl;
 384              return false;
 385         }
 386         actualFilename = EvalFileDefaultName;
 387     }
 388
 389     std::ofstream stream(actualFilename, std::ios_base::binary);
 390     bool saved = save_eval(stream);
 391
 392     msg = saved ? "Network saved successfully to " + actualFilename
 393                 : "Failed to export a net";
 394
 395     sync_cout << msg << sync_endl;
 396     return saved;
 397   }
 398
 399
 400 } // namespace Stockfish::Eval::NNUE