2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2023 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 // Input features and network structure used in NNUE evaluation function
21 #ifndef NNUE_ARCHITECTURE_H_INCLUDED
22 #define NNUE_ARCHITECTURE_H_INCLUDED
28 #include "features/half_ka_v2_hm.h"
29 #include "layers/affine_transform.h"
30 #include "layers/affine_transform_sparse_input.h"
31 #include "layers/clipped_relu.h"
32 #include "layers/sqr_clipped_relu.h"
33 #include "nnue_common.h"
35 namespace Stockfish::Eval::NNUE {
37 // Input features used in evaluation function
38 using FeatureSet = Features::HalfKAv2_hm;
40 // Number of input feature dimensions after conversion
41 constexpr IndexType TransformedFeatureDimensions = 2560;
42 constexpr IndexType PSQTBuckets = 8;
43 constexpr IndexType LayerStacks = 8;
46 static constexpr int FC_0_OUTPUTS = 15;
47 static constexpr int FC_1_OUTPUTS = 32;
49 Layers::AffineTransformSparseInput<TransformedFeatureDimensions, FC_0_OUTPUTS + 1> fc_0;
50 Layers::SqrClippedReLU<FC_0_OUTPUTS + 1> ac_sqr_0;
51 Layers::ClippedReLU<FC_0_OUTPUTS + 1> ac_0;
52 Layers::AffineTransform<FC_0_OUTPUTS * 2, FC_1_OUTPUTS> fc_1;
53 Layers::ClippedReLU<FC_1_OUTPUTS> ac_1;
54 Layers::AffineTransform<FC_1_OUTPUTS, 1> fc_2;
56 // Hash value embedded in the evaluation file
57 static constexpr std::uint32_t get_hash_value() {
59 std::uint32_t hashValue = 0xEC42E90Du;
60 hashValue ^= TransformedFeatureDimensions * 2;
62 hashValue = decltype(fc_0)::get_hash_value(hashValue);
63 hashValue = decltype(ac_0)::get_hash_value(hashValue);
64 hashValue = decltype(fc_1)::get_hash_value(hashValue);
65 hashValue = decltype(ac_1)::get_hash_value(hashValue);
66 hashValue = decltype(fc_2)::get_hash_value(hashValue);
71 // Read network parameters
72 bool read_parameters(std::istream& stream) {
73 return fc_0.read_parameters(stream) && ac_0.read_parameters(stream)
74 && fc_1.read_parameters(stream) && ac_1.read_parameters(stream)
75 && fc_2.read_parameters(stream);
78 // Write network parameters
79 bool write_parameters(std::ostream& stream) const {
80 return fc_0.write_parameters(stream) && ac_0.write_parameters(stream)
81 && fc_1.write_parameters(stream) && ac_1.write_parameters(stream)
82 && fc_2.write_parameters(stream);
85 std::int32_t propagate(const TransformedFeatureType* transformedFeatures) {
86 struct alignas(CacheLineSize) Buffer {
87 alignas(CacheLineSize) decltype(fc_0)::OutputBuffer fc_0_out;
88 alignas(CacheLineSize) decltype(ac_sqr_0)::OutputType
89 ac_sqr_0_out[ceil_to_multiple<IndexType>(FC_0_OUTPUTS * 2, 32)];
90 alignas(CacheLineSize) decltype(ac_0)::OutputBuffer ac_0_out;
91 alignas(CacheLineSize) decltype(fc_1)::OutputBuffer fc_1_out;
92 alignas(CacheLineSize) decltype(ac_1)::OutputBuffer ac_1_out;
93 alignas(CacheLineSize) decltype(fc_2)::OutputBuffer fc_2_out;
95 Buffer() { std::memset(this, 0, sizeof(*this)); }
98 #if defined(__clang__) && (__APPLE__)
99 // workaround for a bug reported with xcode 12
100 static thread_local auto tlsBuffer = std::make_unique<Buffer>();
101 // Access TLS only once, cache result.
102 Buffer& buffer = *tlsBuffer;
104 alignas(CacheLineSize) static thread_local Buffer buffer;
107 fc_0.propagate(transformedFeatures, buffer.fc_0_out);
108 ac_sqr_0.propagate(buffer.fc_0_out, buffer.ac_sqr_0_out);
109 ac_0.propagate(buffer.fc_0_out, buffer.ac_0_out);
110 std::memcpy(buffer.ac_sqr_0_out + FC_0_OUTPUTS, buffer.ac_0_out,
111 FC_0_OUTPUTS * sizeof(decltype(ac_0)::OutputType));
112 fc_1.propagate(buffer.ac_sqr_0_out, buffer.fc_1_out);
113 ac_1.propagate(buffer.fc_1_out, buffer.ac_1_out);
114 fc_2.propagate(buffer.ac_1_out, buffer.fc_2_out);
116 // buffer.fc_0_out[FC_0_OUTPUTS] is such that 1.0 is equal to 127*(1<<WeightScaleBits) in
117 // quantized form, but we want 1.0 to be equal to 600*OutputScale
118 std::int32_t fwdOut =
119 int(buffer.fc_0_out[FC_0_OUTPUTS]) * (600 * OutputScale) / (127 * (1 << WeightScaleBits));
120 std::int32_t outputValue = buffer.fc_2_out[0] + fwdOut;
126 } // namespace Stockfish::Eval::NNUE
128 #endif // #ifndef NNUE_ARCHITECTURE_H_INCLUDED