Skip to content

Commit 78c88af

Browse files
committed
Update and clean up the readme
1 parent affda85 commit 78c88af

File tree

1 file changed

+33
-19
lines changed

1 file changed

+33
-19
lines changed

README.md

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,44 @@
11
# Setup
22

3-
#### Install PyTorch
3+
### Software prerequisites
44

5-
[PyTorch installation guide](https://pytorch.org/get-started/locally/)
5+
#### Python
66

7-
```
8-
python3 -m venv env
9-
source env/bin/activate
10-
pip install python-chess==0.31.4 pytorch-lightning==1.9.5 torch matplotlib tensorboard
11-
```
7+
If using easy_train.py then at least 3.7 is required.
8+
9+
Otherwise versions around 3.6 should also work, but updating is recommended.
10+
11+
Python 3.11 was also tested and works well.
12+
13+
#### A C++ compiler
14+
15+
If you're using easy_train.py then at least GCC 9.2 is required for compiling the data loader, Stockfish, and c-chess-cli. This a defensive version requirement as older versions were known to cause problems with Stockfish.
16+
17+
If you're not using easy_train.py then no automatic compilation will take place; use what you wish.
18+
19+
If you're on Windows the best way is to probably use [MSYS2](https://www.msys2.org/). It would also make it easy to install Make (next step).
20+
21+
#### Make
22+
23+
For compiling Stockfish and c-chess-cli. Not strictly necessary if you're not using easy_train.py, but recommended.
24+
25+
#### CMake
26+
27+
Necessary for compiling the data loader.
28+
29+
https://cmake.org/install/
30+
31+
### Package dependencies
1232

13-
#### Install CuPy
14-
First check what version of cuda is being used by pytorch.
15-
```
16-
import torch
17-
torch.version.cuda
18-
```
19-
Then install CuPy with the matching CUDA version.
2033
```
21-
pip install cupy-cudaXXX
34+
python -m venv trainer
35+
pip install -r requirements.txt
2236
```
23-
where XXX corresponds to the first 3 digits of the CUDA version. For example `cupy-cuda112` for CUDA 11.2.
2437

25-
CuPy might use the PyTorch's private installation of CUDA, but it is better to install the matching version of CUDA separately. [CUDA Downloads](https://developer.nvidia.com/cuda-downloads)
38+
PyTorch with CUDA 11.8 will be automatically installed, along with the matching CuPy version.
39+
40+
### The data loader (if not using easy_train.py)
2641

27-
#### Build the fast DataLoader
2842
This requires a C++17 compiler and cmake.
2943

3044
Windows:
@@ -126,4 +140,4 @@ This script runs in a loop, and will monitor the directory for new checkpoints.
126140
* syzygy - http://www.talkchess.com/forum3/viewtopic.php?f=7&t=75506
127141
* https://github.com/DanielUranga/TensorFlowNNUE
128142
* https://hxim.github.io/Stockfish-Evaluation-Guide/
129-
* dkappe - Suggesting ranger (https://github.com/lessw2020/Ranger-Deep-Learning-Optimizer)
143+
* dkappe - Suggesting ranger (https://github.com/lessw2020/Ranger-Deep-Learning-Optimizer)

0 commit comments

Comments
 (0)