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