About this fork: This fork of ELF has the following changes:

• Makes scripts/elfgames/go/gtp.sh work on PyTorch 1.12.0. At some point, PyTorch had a change that broke gtp.sh. Using an old version of PyTorch is not always an option, however. Newer GPUs require newer versions of CUDA that require new versions of PyTorch.
• Removes the move limit that causes ELF to end games after 722 moves. Having a move limit makes sense for training but is undesirable when playing against ELF via GTP.

ELF is an Extensive, Lightweight, and Flexible platform for game research. We have used it to build our Go playing bot, ELF OpenGo, which achieved a 14-0 record versus four global top-30 players in April 2018. The final score is 20-0 (each professional Go player plays 5 games).

Please refer to our website for a full overview of ELF OpenGo-related resources, including pretrained models, numerous datasets, and a comprehensive visualization of human Go games throughout history leveraging ELF OpenGo's analysis capabilities.

This version is a successor to the original ELF platform.

DISCLAIMER: this code is early research code. What this means is:

• It may not work reliably (or at all) on your system.
• The code quality and documentation are quite lacking, and much of the code might still feel "in-progress".
• There are quite a few hacks made specifically for our systems and infrastructure.

ELF is released under the BSD-style licence found in the LICENSE file.

If you use ELF in your research, please consider citing the original NIPS paper as follows:

@inproceedings{tian2017elf,
  author = {Yuandong Tian and Qucheng Gong and Wenling Shang and Yuxin Wu and C. Lawrence Zitnick},
  title = {ELF: An extensive, lightweight and flexible research platform for real-time strategy games},
  booktitle = {Advances in Neural Information Processing Systems},
  pages = {2656--2666},
  year = {2017}
}

If you use ELF OpenGo or OpenGo-like functionality, please consider citing the technical report as follows:

@inproceedings{tian2019opengo,
  author    = {Yuandong Tian and
               Jerry Ma and
               Qucheng Gong and
               Shubho Sengupta and
               Zhuoyuan Chen and
               James Pinkerton and
               Larry Zitnick},
  title     = {{ELF} OpenGo: an analysis and open reimplementation of AlphaZero},
  booktitle = {Proceedings of the 36th International Conference on Machine Learning,
               {ICML} 2019, 9-15 June 2019, Long Beach, California, {USA}},
  pages     = {6244--6253},
  year      = {2019},
  url       = {http://proceedings.mlr.press/v97/tian19a.html}
}

* Jerry Ma, Qucheng Gong, and Shubho Sengupta contributed equally.

** We also thank Yuxin Wu for his help on this project.

We run ELF using:

• Ubuntu 18.04
• Python 3.7
• GCC 7.3
• CUDA 10.0
• CUDNN 7.3
• NCCL 2.1.2

At the moment, this is the only supported environment. Other environments may also work, but we unfortunately do not have the manpower to investigate compatibility issues.

Here are the dependency installation commands for Ubuntu 18.04 and conda:

sudo apt-get install cmake g++ gcc libboost-all-dev libzmq3-dev
conda install numpy zeromq pyzmq

# From the project root
git submodule sync && git submodule update --init --recursive

You also need to install PyTorch 1.0.0 or later:

conda install pytorch torchvision cudatoolkit=10.0 -c pytorch

A Dockerfile has been provided if you wish to build ELF using Docker.

cd to the project root and run make to build.

After building, cd to the project root and run make test to test.

Currently, ELF must be run straight from source. You'll need to run source scripts/devmode_set_pythonpath.sh to augment $PYTHONPATH appropriately.

To train a model, please follow these steps:

1. Build ELF and run source scripts/devmode_set_pythonpath.sh as described above.
2. Change directory to scripts/elfgames/go/
3. Edit server_addrs.py to specify the server's IP address. This is the machine that will train the neural network.
4. Create the directory where the server will write the model directory. This defaults to myserver
5. Run start_server.sh to start the server. We have tested this on a machine with 8 GPUs.
6. Run start_client.sh to start the clients. The clients should be able to read the model written by the server, so the clients and the server need to mount the same directory via NFS. We have tested this on 2000 clients, each running exclusively on one GPU.

Here is a basic set of commands to run and play the bot via the GTP protocol:

1. Build ELF and run source scripts/devmode_set_pythonpath.sh as described above.
2. Train a model, or grab a pretrained model.
3. Change directory to scripts/elfgames/go/
4. Run ./gtp.sh path/to/modelfile.bin --verbose --gpu 0 --num_block 20 --dim 256 --mcts_puct 1.50 --batchsize 16 --mcts_rollout_per_batch 16 --mcts_threads 2 --mcts_rollout_per_thread 8192 --resign_thres 0.05 --mcts_virtual_loss 1

We've found that the above settings work well for playing the bot. You may change mcts_rollout_per_thread to tune the thinking time per move.

After the environment is set up and the model is loaded, you can start to type gtp commands to get the response from the engine.

Here is the command to analyze an existing sgf file:

1. Build ELF and run source scripts/devmode_set_pythonpath.sh as described above.
2. Train a model, or grab a pretrained model.
3. Change directory to scripts/elfgames/go/
4. Run ./analysis.sh /path/to/model --preload_sgf /path/to/sgf --preload_sgf_move_to [move_number] --dump_record_prefix [tree] --verbose --gpu 0 --mcts_puct 1.50 --batchsize 16 --mcts_rollout_per_batch 16 --mcts_threads 2 --mcts_rollout_per_thread 8192 --resign_thres 0.0 --mcts_virtual_loss 1 --num_games 1

The settings for rollouts are similar as above. The process should run automatically after loading the environment, models and previous moves. You should see the move suggested by the AI after each move, along with its value and prior. This process will also generate a lot of tree files, prefixed with tree (you can change it with --dump_record_prefix option above.) The tree files will contain the full search at each move along with its prior and value. To abort the process simply kill it as the current implementation will run it to the end of the game.

We provide a collection of just over 100 ladder scenarios in the ladder_suite/ directory.