Installing Zeus

This document explains how to install the zeus Python package.

Tip

We encourage users to utilize our Docker image. Please refer to Environment setup. Quick command:

docker run -it --gpus all --cap-add SYS_ADMIN --ipc host mlenergy/zeus:latest bash

zeus Python package

Note

This is already installed inside the container if you're using our Docker image.

Install zeus

To install the latest stable release of zeus:

pip install zeus-ml

If you would like to follow HEAD:

git clone https://github.com/ml-energy/zeus.git zeus
cd zeus
pip install .

For those would like to make changes to the source code and run them, we suggest an editable installation:

git clone https://github.com/ml-energy/zeus.git zeus
cd zeus
pip install -e .