hanabi-learning-environment

(★ 669)

hanabi_learning_environment is a research platform for Hanabi experiments.

File Explorer

Download Latest Version (.zip)

- CMakeLists.txt
- game_example.cc
- game_example.py
- README.md
- rl_env_example.py
- - __init__.py
  - random_agent.py
  - simple_agent.py
- - canonical_encoders.cc
  - canonical_encoders.h
  - CMakeLists.txt
  - hanabi_card.cc
  - hanabi_card.h
  - hanabi_game.cc
  - hanabi_game.h
  - hanabi_hand.cc
  - hanabi_hand.h
  - hanabi_history_item.cc
  - hanabi_history_item.h
  - hanabi_move.cc
  - hanabi_move.h
  - hanabi_observation.cc
  - hanabi_observation.h
  - hanabi_state.cc
  - hanabi_state.h
  - observation_encoder.h
  - util.cc
  - util.h
- __init__.py
- CMakeLists.txt
- pyhanabi.cc
- pyhanabi.h
- pyhanabi.py
- rl_env.py
.gitignore
clean_all.sh
CMakeLists.txt
CONTRIBUTING.md
LICENSE
pyproject.toml
README.md
setup.py

# Installation Guide

1. Get the code

git clone https://github.com/google-deepmind/hanabi-learning-environment

Downloads the entire project code from GitHub to your computer.

cd hanabi-learning-environment

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
Python 3 Python is required to use pip.

sudo apt-get install g++ # if you don't already have a CXX compiler

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo apt-get install python-pip # if you don't already have pip

Installs directly from the APT package repository (Debian/Ubuntu-based).

pip install . # or pip install git+repo_url to install directly from github

Installs the package published on PyPI directly — no need to clone the source.

pip install numpy # game_example.py uses numpy

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. CMake

Medium

Prerequisites

Git Needed to download the project code from GitHub.
CMake The tool used to generate build configuration.
C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.

mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

sudo apt-get install python-pip # if you don't already have pip

Installs directly from the APT package repository (Debian/Ubuntu-based).

pip install . # or pip install git+repo_url to install directly from github

Installs the package published on PyPI directly — no need to clone the source.

pip install numpy # game_example.py uses numpy

Installs the package published on PyPI directly — no need to clone the source.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.