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