Installation Guide¶
If all you want is to use PGMax’s functionality in your own project, go ahead and follow the User Installation Instructions below. If, however, you’re interested in contributing to the development of PGMax, then go ahead and follow the Developer Installation Instructions. Regardless of which install you choose, do follow the GPU Installation instructions if your system is equipped with a GPU.
User Installation Instructions¶
From PyPI
pip install pgmax
From GitHub
pip install git+https://github.com/deepmind/PGMax.git
Developer Installation Instructions¶
git clone https://github.com/deepmind/PGMax.git
cd PGMax
python3 -m venv pgmax_env
source pgmax_env/bin/activate
pip install --upgrade pip setuptools wheel
pip install -r requirements.txt
python3 setup.py develop
GPU Installation¶
By default the above commands install JAX for CPU. If you have access to a GPU, follow the official instructions here to install JAX for GPU.