Installation¶

Install with pip or uv¶

For users working with the pip package manager, hyperbench can be installed from PyPI.

pip install hyperbench
# if you want to install optional dependencies for tensorboard support:
pip install "hyperbench[tensorboard]"

Additionally, it is recommended to install and run hyperbench from a virtual environment, for example, using the Python standard library’s venv. Internally, we use uv as a build and development tool, which also provides a convenient way to manage virtual environments and dependencies. After installing uv, you can create a project environment and add hyperbench with:

uv init
uv add hyperbench # or uv pip install hyperbench

# For optional dependencies
uv add "hyperbench[tensorboard]"

Python version support¶

See Python support policy in Policies.

Install from source¶

Use the development installation for contributing or if you want to use the latest features that haven't been released yet. See the Development guide for instructions on setting up a development environment.

Required dependencies¶

HyperBench has the following required dependencies:

Optional dependencies¶

Development dependencies¶