Introduction

If you are new to NNUE, you might want to start reading about NNUE itself in the Fairy-Stockfish wiki.

Since the variant NNUE training code is based on https://github.com/glinscott/nnue-pytorch, you can also have a look at its documentation, e.g., its wiki, for additional information. However, keep in mind that official Stockfish already switched to different architectures, so architecture related information might not apply here, since Fairy-Stockfish still uses a HalfKAv2 based NNUE architecture. Furthermore Fairy-Stockfish uses a generalized bin training data format (with 512 instead of 256 bit) incompatible with the official Stockfish trainer.

For deeper technical insight into the differences between the training data and NNUE networks in Fairy-Stockfish compared to official Stockfish, see https://github.com/ianfab/variant-nnue-pytorch/wiki/Technical-details.

What you need

• A CUDA capable GPU: https://developer.nvidia.com/cuda-gpus
• CUDA: https://developer.nvidia.com/cuda-downloads
• Training data generator: https://github.com/ianfab/variant-nnue-tools
• Training code: https://github.com/ianfab/variant-nnue-pytorch

Steps

Variant choice

Before starting the training, please check if any of the limitations mentioned in the FAQ apply to the variant you want train.

Training data generation

The first step in the training of NNUE networks is the generation of training data. The training data generator code is based on Fairy-Stockfish and is available at https://github.com/ianfab/Fairy-Stockfish/tree/tools. Building the training data generator code from source works the same way as compiling Fairy-Stockfish.

See https://github.com/ianfab/variant-nnue-pytorch/wiki/Training-data-generation for more details on training data generation.

NNUE training

In order to run NNUE training for specific variants, the code requires minor adjustments to specify board size, piece types, etc. The reason for that is that the training code is variant-agnostic and other than those minor adaptations has no knowledge of the rules of the variants. The training data generator prints the recommended training code changes when setting a variant using the UCI_Variant, you just need to apply these changes to the lib/nnue_training_data_formats.h and variant.py files in the training code.

After that you can run the main train.py script to train an NNUE network with generated training data. As a final step of the training the generated network needs to be transformed to the format compatible with Fairy-Stockfish using the serialize.py script.

See https://github.com/ianfab/variant-nnue-pytorch/wiki/NNUE-training for more details.

Testing

In order to test a trained NNUE network, there are several options depending on the variant.

• cutechess is both available as a GUI and a command line client and can run engine matches for a large number of variants.
• variantfishtest is a simple variant-agnostic testing script that can be used for testing of arbitrary variants in Fairy-Stockfish.
• fairyfishtest is another python script similar to variantfishtest and also can be used for all variants supported by Fairy-Stockfish. It is mainly used for testing four-player variants like bughouse.

Upload

When a trained NNUE network performns well in testing, you can upload it via this form to make it available here. After that, please also update the list of current strongest NNUE networks, so that others can easily find it.

Limitations

• Both the training data generation tool as well as this repository only support the bin format and no binpack or plain formats.
• Many of the helper scripts/functionality in the training data generation and this repository are not maintained and likely broken. The essential functionality of generating bin training data and using it for NNUE training of HalfKAv2 networks with the train.py and serialize.py scripts is working though.

See the FAQ for more info on supported variants and common pitfalls.