Always re-enable NNUE after "bench".
[stockfish] / README.md
1 ## Overview
2
3 [![Build Status](https://travis-ci.org/official-stockfish/Stockfish.svg?branch=master)](https://travis-ci.org/official-stockfish/Stockfish)
4 [![Build Status](https://ci.appveyor.com/api/projects/status/github/official-stockfish/Stockfish?branch=master&svg=true)](https://ci.appveyor.com/project/mcostalba/stockfish/branch/master)
5
6 [Stockfish](https://stockfishchess.org) is a free, powerful UCI chess engine
7 derived from Glaurung 2.1. Stockfish is not a complete chess program and requires a
8 UCI-compatible graphical user interface (GUI) (e.g. XBoard with PolyGlot, Scid,
9 Cute Chess, eboard, Arena, Sigma Chess, Shredder, Chess Partner or Fritz) in order
10 to be used comfortably. Read the documentation for your GUI of choice for information
11 about how to use Stockfish with it.
12
13 The Stockfish engine features two evaluation functions for chess, the classical
14 evaluation based on handcrafted terms, and the NNUE evaluation based on efficiently
15 updateable neural networks. The classical evaluation runs efficiently on almost all
16 CPU architectures, while the NNUE evaluation benefits from the vector
17 intrinsics available on most CPUs (sse2, avx2, neon, or similar).
18
19
20 ## Files
21
22 This distribution of Stockfish consists of the following files:
23
24   * Readme.md, the file you are currently reading.
25
26   * Copying.txt, a text file containing the GNU General Public License version 3.
27
28   * src, a subdirectory containing the full source code, including a Makefile
29     that can be used to compile Stockfish on Unix-like systems.
30
31   * a file with the .nnue extension, storing the neural network for the NNUE 
32     evaluation. Binary distributions will have this file embedded.
33
34 Note: to use the NNUE evaluation, the additional data file with neural network parameters
35 needs to be available. Normally, this file is already embedded in the binary or it can be downloaded.
36 The filename for the default (recommended) net can be found as the default
37 value of the `EvalFile` UCI option, with the format `nn-[SHA256 first 12 digits].nnue`
38 (for instance, `nn-c157e0a5755b.nnue`). This file can be downloaded from
39 ```
40 https://tests.stockfishchess.org/api/nn/[filename]
41 ```
42 replacing `[filename]` as needed.
43
44
45 ## UCI options
46
47 Currently, Stockfish has the following UCI options:
48
49   * #### Threads
50     The number of CPU threads used for searching a position. For best performance, set
51     this equal to the number of CPU cores available.
52
53   * #### Hash
54     The size of the hash table in MB. It is recommended to set Hash after setting Threads.
55
56   * #### Ponder
57     Let Stockfish ponder its next move while the opponent is thinking.
58
59   * #### MultiPV
60     Output the N best lines (principal variations, PVs) when searching.
61     Leave at 1 for best performance.
62
63   * #### Use NNUE
64     Toggle between the NNUE and classical evaluation functions. If set to "true",
65     the network parameters must be available to load from file (see also EvalFile),
66     if they are not embedded in the binary.
67
68   * #### EvalFile
69     The name of the file of the NNUE evaluation parameters. Depending on the GUI the
70     filename might have to include the full path to the folder/directory that contains the file.
71     Other locations, such as the directory that contains the binary and the working directory,
72     are also searched.
73
74   * #### UCI_AnalyseMode
75     An option handled by your GUI.
76
77   * #### UCI_Chess960
78     An option handled by your GUI. If true, Stockfish will play Chess960.
79
80   * #### UCI_ShowWDL
81     If enabled, show approximate WDL statistics as part of the engine output.
82     These WDL numbers model expected game outcomes for a given evaluation and
83     game ply for engine self-play at fishtest LTC conditions (60+0.6s per game).
84
85   * #### UCI_LimitStrength
86     Enable weaker play aiming for an Elo rating as set by UCI_Elo. This option overrides Skill Level.
87
88   * #### UCI_Elo
89     If enabled by UCI_LimitStrength, aim for an engine strength of the given Elo.
90     This Elo rating has been calibrated at a time control of 60s+0.6s and anchored to CCRL 40/4.
91
92   * #### Skill Level
93     Lower the Skill Level in order to make Stockfish play weaker (see also UCI_LimitStrength).
94     Internally, MultiPV is enabled, and with a certain probability depending on the Skill Level a
95     weaker move will be played.
96
97   * #### SyzygyPath
98     Path to the folders/directories storing the Syzygy tablebase files. Multiple
99     directories are to be separated by ";" on Windows and by ":" on Unix-based
100     operating systems. Do not use spaces around the ";" or ":".
101
102     Example: `C:\tablebases\wdl345;C:\tablebases\wdl6;D:\tablebases\dtz345;D:\tablebases\dtz6`
103
104     It is recommended to store .rtbw files on an SSD. There is no loss in storing
105     the .rtbz files on a regular HD. It is recommended to verify all md5 checksums
106     of the downloaded tablebase files (`md5sum -c checksum.md5`) as corruption will
107     lead to engine crashes.
108
109   * #### SyzygyProbeDepth
110     Minimum remaining search depth for which a position is probed. Set this option
111     to a higher value to probe less agressively if you experience too much slowdown
112     (in terms of nps) due to TB probing.
113
114   * #### Syzygy50MoveRule
115     Disable to let fifty-move rule draws detected by Syzygy tablebase probes count
116     as wins or losses. This is useful for ICCF correspondence games.
117
118   * #### SyzygyProbeLimit
119     Limit Syzygy tablebase probing to positions with at most this many pieces left
120     (including kings and pawns).
121
122   * #### Contempt
123     A positive value for contempt favors middle game positions and avoids draws,
124     effective for the classical evaluation only.
125
126   * #### Analysis Contempt
127     By default, contempt is set to prefer the side to move. Set this option to "White"
128     or "Black" to analyse with contempt for that side, or "Off" to disable contempt.
129
130   * #### Move Overhead
131     Assume a time delay of x ms due to network and GUI overheads. This is useful to
132     avoid losses on time in those cases.
133
134   * #### Slow Mover
135     Lower values will make Stockfish take less time in games, higher values will
136     make it think longer.
137
138   * #### nodestime
139     Tells the engine to use nodes searched instead of wall time to account for
140     elapsed time. Useful for engine testing.
141
142   * #### Clear Hash
143     Clear the hash table.
144
145   * #### Debug Log File
146     Write all communication to and from the engine into a text file.
147
148 ## A note on classical and NNUE evaluation
149
150 Both approaches assign a value to a position that is used in alpha-beta (PVS) search
151 to find the best move. The classical evaluation computes this value as a function
152 of various chess concepts, handcrafted by experts, tested and tuned using fishtest.
153 The NNUE evaluation computes this value with a neural network based on basic
154 inputs (e.g. piece positions only). The network is optimized and trained
155 on the evalutions of millions of positions at moderate search depth.
156
157 The NNUE evaluation was first introduced in shogi, and ported to Stockfish afterward.
158 It can be evaluated efficiently on CPUs, and exploits the fact that only parts
159 of the neural network need to be updated after a typical chess move.
160 [The nodchip repository](https://github.com/nodchip/Stockfish) provides additional
161 tools to train and develop the NNUE networks.
162
163 On CPUs supporting modern vector instructions (avx2 and similar), the NNUE evaluation
164 results in stronger playing strength, even if the nodes per second computed by the engine
165 is somewhat lower (roughly 60% of nps is typical).
166
167 Note that the NNUE evaluation depends on the Stockfish binary and the network parameter
168 file (see EvalFile). Not every parameter file is compatible with a given Stockfish binary.
169 The default value of the EvalFile UCI option is the name of a network that is guaranteed
170 to be compatible with that binary.
171
172 ## What to expect from Syzygybases?
173
174 If the engine is searching a position that is not in the tablebases (e.g.
175 a position with 8 pieces), it will access the tablebases during the search.
176 If the engine reports a very large score (typically 153.xx), this means
177 that it has found a winning line into a tablebase position.
178
179 If the engine is given a position to search that is in the tablebases, it
180 will use the tablebases at the beginning of the search to preselect all
181 good moves, i.e. all moves that preserve the win or preserve the draw while
182 taking into account the 50-move rule.
183 It will then perform a search only on those moves. **The engine will not move
184 immediately**, unless there is only a single good move. **The engine likely
185 will not report a mate score even if the position is known to be won.**
186
187 It is therefore clear that this behaviour is not identical to what one might
188 be used to with Nalimov tablebases. There are technical reasons for this
189 difference, the main technical reason being that Nalimov tablebases use the
190 DTM metric (distance-to-mate), while Syzygybases use a variation of the
191 DTZ metric (distance-to-zero, zero meaning any move that resets the 50-move
192 counter). This special metric is one of the reasons that Syzygybases are
193 more compact than Nalimov tablebases, while still storing all information
194 needed for optimal play and in addition being able to take into account
195 the 50-move rule.
196
197 ## Large Pages
198
199 Stockfish supports large pages on Linux and Windows. Large pages make
200 the hash access more efficient, improving the engine speed, especially
201 on large hash sizes. Typical increases are 5..10% in terms of nps, but
202 speed increases up to 30% have been measured. The support is
203 automatic. Stockfish attempts to use large pages when available and
204 will fall back to regular memory allocation when this is not the case.
205
206 ### Support on Linux
207
208 Large page support on Linux is obtained by the Linux kernel
209 transparent huge pages functionality. Typically, transparent huge pages
210 are already enabled and no configuration is needed.
211
212 ### Support on Windows
213
214 The use of large pages requires "Lock Pages in Memory" privilege. See
215 [Enable the Lock Pages in Memory Option (Windows)](https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/enable-the-lock-pages-in-memory-option-windows)
216 on how to enable this privilege. Logout/login may be needed
217 afterwards. Due to memory fragmentation, it may not always be
218 possible to allocate large pages even when enabled. A reboot
219 might alleviate this problem. To determine whether large pages
220 are in use, see the engine log.
221
222 ## Compiling Stockfish yourself from the sources
223
224 Stockfish has support for 32 or 64-bit CPUs, certain hardware
225 instructions, big-endian machines such as Power PC, and other platforms.
226
227 On Unix-like systems, it should be easy to compile Stockfish
228 directly from the source code with the included Makefile in the folder
229 `src`. In general it is recommended to run `make help` to see a list of make
230 targets with corresponding descriptions.
231
232 ```
233     cd src
234     make help
235     make build ARCH=x86-64-modern
236     make net
237 ```
238
239 When not using the Makefile to compile (for instance with Microsoft MSVC) you
240 need to manually set/unset some switches in the compiler command line; see
241 file *types.h* for a quick reference.
242
243 When reporting an issue or a bug, please tell us which version and
244 compiler you used to create your executable. These informations can
245 be found by typing the following commands in a console:
246
247 ```
248     ./stockfish compiler
249 ```
250
251 ## Understanding the code base and participating in the project
252
253 Stockfish's improvement over the last couple of years has been a great
254 community effort. There are a few ways to help contribute to its growth.
255
256 ### Donating hardware
257
258 Improving Stockfish requires a massive amount of testing. You can donate
259 your hardware resources by installing the [Fishtest Worker](https://github.com/glinscott/fishtest/wiki/Running-the-worker:-overview)
260 and view the current tests on [Fishtest](https://tests.stockfishchess.org/tests).
261
262 ### Improving the code
263
264 If you want to help improve the code, there are several valuable resources:
265
266 * [In this wiki,](https://www.chessprogramming.org) many techniques used in
267 Stockfish are explained with a lot of background information.
268
269 * [The section on Stockfish](https://www.chessprogramming.org/Stockfish)
270 describes many features and techniques used by Stockfish. However, it is
271 generic rather than being focused on Stockfish's precise implementation.
272 Nevertheless, a helpful resource.
273
274 * The latest source can always be found on [GitHub](https://github.com/official-stockfish/Stockfish).
275 Discussions about Stockfish take place in the [FishCooking](https://groups.google.com/forum/#!forum/fishcooking)
276 group and engine testing is done on [Fishtest](https://tests.stockfishchess.org/tests).
277 If you want to help improve Stockfish, please read this [guideline](https://github.com/glinscott/fishtest/wiki/Creating-my-first-test)
278 first, where the basics of Stockfish development are explained.
279
280
281 ## Terms of use
282
283 Stockfish is free, and distributed under the **GNU General Public License version 3**
284 (GPL v3). Essentially, this means that you are free to do almost exactly
285 what you want with the program, including distributing it among your
286 friends, making it available for download from your web site, selling
287 it (either by itself or as part of some bigger software package), or
288 using it as the starting point for a software project of your own.
289
290 The only real limitation is that whenever you distribute Stockfish in
291 some way, you must always include the full source code, or a pointer
292 to where the source code can be found. If you make any changes to the
293 source code, these changes must also be made available under the GPL.
294
295 For full details, read the copy of the GPL v3 found in the file named
296 *Copying.txt*.