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