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