2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2022 The Stockfish developers (see AUTHORS file)
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.
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.
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/>.
19 // Code for calculating NNUE evaluation function
27 #include "../evaluate.h"
28 #include "../position.h"
33 #include "evaluate_nnue.h"
35 namespace Stockfish::Eval::NNUE {
37 // Input feature converter
38 LargePagePtr<FeatureTransformer> featureTransformer;
40 // Evaluation function
41 AlignedPtr<Network> network[LayerStacks];
43 // Evaluation function file name
45 std::string netDescription;
49 // Initialize the evaluation function parameters
51 void initialize(AlignedPtr<T>& pointer) {
53 pointer.reset(reinterpret_cast<T*>(std_aligned_alloc(alignof(T), sizeof(T))));
54 std::memset(pointer.get(), 0, sizeof(T));
58 void initialize(LargePagePtr<T>& pointer) {
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));
65 // Read evaluation function parameters
67 bool read_parameters(std::istream& stream, T& reference) {
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);
75 // Write evaluation function parameters
77 bool write_parameters(std::ostream& stream, const T& reference) {
79 write_little_endian<std::uint32_t>(stream, T::get_hash_value());
80 return reference.write_parameters(stream);
85 // Initialize the evaluation function parameters
88 Detail::initialize(featureTransformer);
89 for (std::size_t i = 0; i < LayerStacks; ++i)
90 Detail::initialize(network[i]);
93 // Read network header
94 bool read_header(std::istream& stream, std::uint32_t* hashValue, std::string* desc)
96 std::uint32_t version, size;
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;
103 stream.read(&(*desc)[0], size);
104 return !stream.fail();
107 // Write network header
108 bool write_header(std::ostream& stream, std::uint32_t hashValue, const std::string& desc)
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, desc.size());
113 stream.write(&desc[0], desc.size());
114 return !stream.fail();
117 // Read network parameters
118 bool read_parameters(std::istream& stream) {
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();
129 // Write network parameters
130 bool write_parameters(std::ostream& stream) {
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;
139 // Evaluation function. Perform differential calculation.
140 Value evaluate(const Position& pos, bool adjusted) {
142 // We manually align the arrays on the stack because with gcc < 9.3
143 // overaligning stack variables with alignas() doesn't work correctly.
145 constexpr uint64_t alignment = CacheLineSize;
148 #if defined(ALIGNAS_ON_STACK_VARIABLES_BROKEN)
149 TransformedFeatureType transformedFeaturesUnaligned[
150 FeatureTransformer::BufferSize + alignment / sizeof(TransformedFeatureType)];
151 char bufferUnaligned[Network::BufferSize + alignment];
153 auto* transformedFeatures = align_ptr_up<alignment>(&transformedFeaturesUnaligned[0]);
154 auto* buffer = align_ptr_up<alignment>(&bufferUnaligned[0]);
157 TransformedFeatureType transformedFeatures[FeatureTransformer::BufferSize];
158 alignas(alignment) char buffer[Network::BufferSize];
161 ASSERT_ALIGNED(transformedFeatures, alignment);
162 ASSERT_ALIGNED(buffer, alignment);
164 const std::size_t bucket = (pos.count<ALL_PIECES>() - 1) / 4;
165 const auto psqt = featureTransformer->transform(pos, transformedFeatures, bucket);
166 const auto positional = network[bucket]->propagate(transformedFeatures, buffer)[0];
168 // Give more value to positional evaluation when adjusted flag is set
170 return static_cast<Value>(((128 - delta) * psqt + (128 + delta) * positional) / 128 / OutputScale);
172 return static_cast<Value>((psqt + positional) / OutputScale);
175 struct NnueEvalTrace {
176 static_assert(LayerStacks == PSQTBuckets);
178 Value psqt[LayerStacks];
179 Value positional[LayerStacks];
180 std::size_t correctBucket;
183 static NnueEvalTrace trace_evaluate(const Position& pos) {
185 // We manually align the arrays on the stack because with gcc < 9.3
186 // overaligning stack variables with alignas() doesn't work correctly.
188 constexpr uint64_t alignment = CacheLineSize;
190 #if defined(ALIGNAS_ON_STACK_VARIABLES_BROKEN)
191 TransformedFeatureType transformedFeaturesUnaligned[
192 FeatureTransformer::BufferSize + alignment / sizeof(TransformedFeatureType)];
193 char bufferUnaligned[Network::BufferSize + alignment];
195 auto* transformedFeatures = align_ptr_up<alignment>(&transformedFeaturesUnaligned[0]);
196 auto* buffer = align_ptr_up<alignment>(&bufferUnaligned[0]);
199 TransformedFeatureType transformedFeatures[FeatureTransformer::BufferSize];
200 alignas(alignment) char buffer[Network::BufferSize];
203 ASSERT_ALIGNED(transformedFeatures, alignment);
204 ASSERT_ALIGNED(buffer, alignment);
207 t.correctBucket = (pos.count<ALL_PIECES>() - 1) / 4;
208 for (std::size_t bucket = 0; bucket < LayerStacks; ++bucket) {
209 const auto psqt = featureTransformer->transform(pos, transformedFeatures, bucket);
210 const auto output = network[bucket]->propagate(transformedFeatures, buffer);
212 int materialist = psqt;
213 int positional = output[0];
215 t.psqt[bucket] = static_cast<Value>( materialist / OutputScale );
216 t.positional[bucket] = static_cast<Value>( positional / OutputScale );
222 static const std::string PieceToChar(" PNBRQK pnbrqk");
225 // format_cp_compact() converts a Value into (centi)pawns and writes it in a buffer.
226 // The buffer must have capacity for at least 5 chars.
227 static void format_cp_compact(Value v, char* buffer) {
229 buffer[0] = (v < 0 ? '-' : v > 0 ? '+' : ' ');
231 int cp = std::abs(100 * v / PawnValueEg);
234 buffer[1] = '0' + cp / 10000; cp %= 10000;
235 buffer[2] = '0' + cp / 1000; cp %= 1000;
236 buffer[3] = '0' + cp / 100;
241 buffer[1] = '0' + cp / 1000; cp %= 1000;
242 buffer[2] = '0' + cp / 100; cp %= 100;
244 buffer[4] = '0' + cp / 10;
248 buffer[1] = '0' + cp / 100; cp %= 100;
250 buffer[3] = '0' + cp / 10; cp %= 10;
251 buffer[4] = '0' + cp / 1;
256 // format_cp_aligned_dot() converts a Value into (centi)pawns and writes it in a buffer,
257 // always keeping two decimals. The buffer must have capacity for at least 7 chars.
258 static void format_cp_aligned_dot(Value v, char* buffer) {
260 buffer[0] = (v < 0 ? '-' : v > 0 ? '+' : ' ');
262 double cp = 1.0 * std::abs(int(v)) / PawnValueEg;
263 sprintf(&buffer[1], "%6.2f", cp);
267 // trace() returns a string with the value of each piece on a board,
268 // and a table for (PSQT, Layers) values bucket by bucket.
270 std::string trace(Position& pos) {
272 std::stringstream ss;
274 char board[3*8+1][8*8+2];
275 std::memset(board, ' ', sizeof(board));
276 for (int row = 0; row < 3*8+1; ++row)
277 board[row][8*8+1] = '\0';
279 // A lambda to output one box of the board
280 auto writeSquare = [&board](File file, Rank rank, Piece pc, Value value) {
282 const int x = ((int)file) * 8;
283 const int y = (7 - (int)rank) * 3;
284 for (int i = 1; i < 8; ++i)
285 board[y][x+i] = board[y+3][x+i] = '-';
286 for (int i = 1; i < 3; ++i)
287 board[y+i][x] = board[y+i][x+8] = '|';
288 board[y][x] = board[y][x+8] = board[y+3][x+8] = board[y+3][x] = '+';
290 board[y+1][x+4] = PieceToChar[pc];
291 if (value != VALUE_NONE)
292 format_cp_compact(value, &board[y+2][x+2]);
295 // We estimate the value of each piece by doing a differential evaluation from
296 // the current base eval, simulating the removal of the piece from its square.
297 Value base = evaluate(pos);
298 base = pos.side_to_move() == WHITE ? base : -base;
300 for (File f = FILE_A; f <= FILE_H; ++f)
301 for (Rank r = RANK_1; r <= RANK_8; ++r)
303 Square sq = make_square(f, r);
304 Piece pc = pos.piece_on(sq);
305 Value v = VALUE_NONE;
307 if (pc != NO_PIECE && type_of(pc) != KING)
309 auto st = pos.state();
311 pos.remove_piece(sq);
312 st->accumulator.computed[WHITE] = false;
313 st->accumulator.computed[BLACK] = false;
315 Value eval = evaluate(pos);
316 eval = pos.side_to_move() == WHITE ? eval : -eval;
319 pos.put_piece(pc, sq);
320 st->accumulator.computed[WHITE] = false;
321 st->accumulator.computed[BLACK] = false;
324 writeSquare(f, r, pc, v);
327 ss << " NNUE derived piece values:\n";
328 for (int row = 0; row < 3*8+1; ++row)
329 ss << board[row] << '\n';
332 auto t = trace_evaluate(pos);
334 ss << " NNUE network contributions "
335 << (pos.side_to_move() == WHITE ? "(White to move)" : "(Black to move)") << std::endl
336 << "+------------+------------+------------+------------+\n"
337 << "| Bucket | Material | Positional | Total |\n"
338 << "| | (PSQT) | (Layers) | |\n"
339 << "+------------+------------+------------+------------+\n";
341 for (std::size_t bucket = 0; bucket < LayerStacks; ++bucket)
344 std::memset(buffer, '\0', sizeof(buffer));
346 format_cp_aligned_dot(t.psqt[bucket], buffer[0]);
347 format_cp_aligned_dot(t.positional[bucket], buffer[1]);
348 format_cp_aligned_dot(t.psqt[bucket] + t.positional[bucket], buffer[2]);
350 ss << "| " << bucket << " "
351 << " | " << buffer[0] << " "
352 << " | " << buffer[1] << " "
353 << " | " << buffer[2] << " "
355 if (bucket == t.correctBucket)
356 ss << " <-- this bucket is used";
360 ss << "+------------+------------+------------+------------+\n";
366 // Load eval, from a file stream or a memory stream
367 bool load_eval(std::string name, std::istream& stream) {
371 return read_parameters(stream);
374 // Save eval, to a file stream or a memory stream
375 bool save_eval(std::ostream& stream) {
377 if (fileName.empty())
380 return write_parameters(stream);
383 /// Save eval, to a file given by its name
384 bool save_eval(const std::optional<std::string>& filename) {
386 std::string actualFilename;
389 if (filename.has_value())
390 actualFilename = filename.value();
393 if (currentEvalFileName != EvalFileDefaultName)
395 msg = "Failed to export a net. A non-embedded net can only be saved if the filename is specified";
397 sync_cout << msg << sync_endl;
400 actualFilename = EvalFileDefaultName;
403 std::ofstream stream(actualFilename, std::ios_base::binary);
404 bool saved = save_eval(stream);
406 msg = saved ? "Network saved successfully to " + actualFilename
407 : "Failed to export a net";
409 sync_cout << msg << sync_endl;
414 } // namespace Stockfish::Eval::NNUE