git.sesse.net Git - stockfish/blob - src/nnue/nnue_architecture.h

   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 // Input features and network structure used in NNUE evaluation function
  20
  21 #ifndef NNUE_ARCHITECTURE_H_INCLUDED
  22 #define NNUE_ARCHITECTURE_H_INCLUDED
  23
  24 #include <cstdint>
  25 #include <cstring>
  26 #include <iosfwd>
  27
  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"
  34
  35 namespace Stockfish::Eval::NNUE {
  36
  37 // Input features used in evaluation function
  38 using FeatureSet = Features::HalfKAv2_hm;
  39
  40 // Number of input feature dimensions after conversion
  41 constexpr IndexType TransformedFeatureDimensions = 2048;
  42 constexpr IndexType PSQTBuckets = 8;
  43 constexpr IndexType LayerStacks = 8;
  44
  45 struct Network
  46 {
  47   static constexpr int FC_0_OUTPUTS = 15;
  48   static constexpr int FC_1_OUTPUTS = 32;
  49
  50   Layers::AffineTransformSparseInput<TransformedFeatureDimensions, FC_0_OUTPUTS + 1> fc_0;
  51   Layers::SqrClippedReLU<FC_0_OUTPUTS + 1> ac_sqr_0;
  52   Layers::ClippedReLU<FC_0_OUTPUTS + 1> ac_0;
  53   Layers::AffineTransform<FC_0_OUTPUTS * 2, FC_1_OUTPUTS> fc_1;
  54   Layers::ClippedReLU<FC_1_OUTPUTS> ac_1;
  55   Layers::AffineTransform<FC_1_OUTPUTS, 1> fc_2;
  56
  57   // Hash value embedded in the evaluation file
  58   static constexpr std::uint32_t get_hash_value() {
  59     // input slice hash
  60     std::uint32_t hashValue = 0xEC42E90Du;
  61     hashValue ^= TransformedFeatureDimensions * 2;
  62
  63     hashValue = decltype(fc_0)::get_hash_value(hashValue);
  64     hashValue = decltype(ac_0)::get_hash_value(hashValue);
  65     hashValue = decltype(fc_1)::get_hash_value(hashValue);
  66     hashValue = decltype(ac_1)::get_hash_value(hashValue);
  67     hashValue = decltype(fc_2)::get_hash_value(hashValue);
  68
  69     return hashValue;
  70   }
  71
  72   // Read network parameters
  73   bool read_parameters(std::istream& stream) {
  74     return   fc_0.read_parameters(stream)
  75           && ac_0.read_parameters(stream)
  76           && fc_1.read_parameters(stream)
  77           && ac_1.read_parameters(stream)
  78           && fc_2.read_parameters(stream);
  79   }
  80
  81   // Write network parameters
  82   bool write_parameters(std::ostream& stream) const {
  83     return   fc_0.write_parameters(stream)
  84           && ac_0.write_parameters(stream)
  85           && fc_1.write_parameters(stream)
  86           && ac_1.write_parameters(stream)
  87           && fc_2.write_parameters(stream);
  88   }
  89
  90   std::int32_t propagate(const TransformedFeatureType* transformedFeatures)
  91   {
  92     struct alignas(CacheLineSize) Buffer
  93     {
  94       alignas(CacheLineSize) decltype(fc_0)::OutputBuffer fc_0_out;
  95       alignas(CacheLineSize) decltype(ac_sqr_0)::OutputType ac_sqr_0_out[ceil_to_multiple<IndexType>(FC_0_OUTPUTS * 2, 32)];
  96       alignas(CacheLineSize) decltype(ac_0)::OutputBuffer ac_0_out;
  97       alignas(CacheLineSize) decltype(fc_1)::OutputBuffer fc_1_out;
  98       alignas(CacheLineSize) decltype(ac_1)::OutputBuffer ac_1_out;
  99       alignas(CacheLineSize) decltype(fc_2)::OutputBuffer fc_2_out;
 100
 101       Buffer()
 102       {
 103           std::memset(this, 0, sizeof(*this));
 104       }
 105     };
 106
 107 #if defined(__clang__) && (__APPLE__)
 108     // workaround for a bug reported with xcode 12
 109     static thread_local auto tlsBuffer = std::make_unique<Buffer>();
 110     // Access TLS only once, cache result.
 111     Buffer& buffer = *tlsBuffer;
 112 #else
 113     alignas(CacheLineSize) static thread_local Buffer buffer;
 114 #endif
 115
 116     fc_0.propagate(transformedFeatures, buffer.fc_0_out);
 117     ac_sqr_0.propagate(buffer.fc_0_out, buffer.ac_sqr_0_out);
 118     ac_0.propagate(buffer.fc_0_out, buffer.ac_0_out);
 119     std::memcpy(buffer.ac_sqr_0_out + FC_0_OUTPUTS, buffer.ac_0_out, FC_0_OUTPUTS * sizeof(decltype(ac_0)::OutputType));
 120     fc_1.propagate(buffer.ac_sqr_0_out, buffer.fc_1_out);
 121     ac_1.propagate(buffer.fc_1_out, buffer.ac_1_out);
 122     fc_2.propagate(buffer.ac_1_out, buffer.fc_2_out);
 123
 124     // buffer.fc_0_out[FC_0_OUTPUTS] is such that 1.0 is equal to 127*(1<<WeightScaleBits) in quantized form
 125     // but we want 1.0 to be equal to 600*OutputScale
 126     std::int32_t fwdOut = int(buffer.fc_0_out[FC_0_OUTPUTS]) * (600*OutputScale) / (127*(1<<WeightScaleBits));
 127     std::int32_t outputValue = buffer.fc_2_out[0] + fwdOut;
 128
 129     return outputValue;
 130   }
 131 };
 132
 133 }  // namespace Stockfish::Eval::NNUE
 134
 135 #endif // #ifndef NNUE_ARCHITECTURE_H_INCLUDED