Skip to content

Installing ado

ado can be installed in one of three ways:

  1. From PyPI
  2. From GitHub
  3. By cloning the GitHub repository locally
Warning

Before proceeding, ensure you are using a supported Python version. Run python --version in your terminal and check that you are on Python 3.10, 3.11, 3.12, 3.13, or 3.14.

It is also highly recommended to create a virtual environment for ado, to avoid dependency conflicts with other packages. You can do so with:

python -m venv ado-venv

And activate it with

source ado-venv/bin/activate

This method installs the ado-core package from PyPI.

pip install ado-core

This installs the current repository directly from GitHub.

pip install git+https://github.com/IBM/ado.git

Clone the repository locally, then install the top-level package:

git clone https://github.com/IBM/ado.git
cd ado
pip install .

If intend to develop ado, refer to our development setup guidelines.

Installing plugins

ado uses a plugin system to provide additional actuators, operators, and custom experiments. We maintain a set of plugins in the ado main repo. Some plugins are also distributed separately on PyPI. You can install these plugins as follows:

Info

Some plugins may have dependencies that require credentials or additional system setup. Check the plugin's documentation if you encounter issues installing a specific plugin.

The following plugin packages are available on PyPI: ado-anomalous-series, ado-autoconf, ado-cplex-mip, ado-profile-space, ado-ray-tune, ado-sfttrainer, ado-trim, and ado-vllm-performance

pip install $PLUGIN_NAME

For actuators:

pip install "git+https://github.com/IBM/ado.git#subdirectory=plugins/actuators/$ACTUATOR_NAME"

For operators:

pip install "git+https://github.com/IBM/ado.git#subdirectory=plugins/operators/$OPERATOR_NAME"

For custom experiments:

pip install "git+https://github.com/IBM/ado.git#subdirectory=plugins/custom_experiments/$CUSTOM_EXPERIMENT_NAME"

If you've cloned the ado repository locally in the previous step, run these commands from the top level of the cloned repository.

For actuators:

pip install plugins/actuators/$ACTUATOR_NAME

For operators:

pip install plugins/operators/$OPERATOR_NAME

For custom experiments:

pip install plugins/custom_experiments/$CUSTOM_EXPERIMENT_NAME

What's next