Note that Summit only works with python 3.8 and 3.9 currently. We are waiting on pytorch to add python 3.10 support.

The easiest way to install Summit is using pip or a depedency manager that supports pip:

pip install summit

You could also use poetry or pipenv:

poetry add summit
pipenv install summit

Summit has a set of extra dependencies for running the code in the experiments folder on Github. You can install them as follows:

# with pip:
pip install summit[experiments]

# with poetry
poetry add summit -E experiments

# with pipenv
pipenv install summit[experiments]

Additionally, if you want to use the experimental ENTMOOT feature you need to install the ENTMOOT package

# with pip:
pip install summit[entmoot]

# with poetryff
poetry add summit -E entmoot

# with pipenv
pipenv install summit[entmoot]

Notes about installing on Apple M1

You might run into some issues when installing scientific python packages such as Summit on Apple M1. Follow the steps below to install via pip:

arch -arm64 brew install llvm@11
brew install hdf5
HDF5_DIR=/opt/homebrew/opt/hdf5 PIP_NO_BINARY="h5py" LLVM_CONFIG="/opt/homebrew/Cellar/llvm@11/11.1.0_3/bin/llvm-config" arch -arm64 poetry install

If this commnad fails, make sure to check the version of LLVM that was actually installed (i.e., run ls /opt/homebrew/Cellar/llvm@11/) and replace 11.1.0_3 in the third line above with the correct version.

More resources: