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