hposuite
A lightweight framework for benchmarking HPO algorithms, providing wrappers for HPO benchmarks and optimizers. Provides a simple API for large-scale HPO experimentation.
Minimal Example to run hposuite
from hposuite import create_study
study = create_study(
name="hposuite_demo",
output_dir="./hposuite-output",
optimizers=[...], # Eg: "RandomSearch"
benchmarks=[...], # Eg: "ackley"
num_seeds=5,
budget=100, # Number of iterations
)
study.optimize()
Installation
Create a Virtual Environment using Venv
python -m venv hposuite_env
source hposuite_env/bin/activate
Installing from PyPI
pip install hposuite
Installation from source
git clone https://github.com/automl/hposuite.git
cd hposuite
pip install -e . # -e for editable install
Simple example to run multiple Optimizers on multiple benchmarks
from hposuite.benchmarks import BENCHMARKS
from hposuite.optimizers import OPTIMIZERS
from hposuite import create_study
study = create_study(
name="smachb_dehb_mfh3good_pd1",
output_dir="./hposuite-output",
optimizers=[
OPTIMIZERS["SMAC_Hyperband"],
OPTIMIZERS["DEHB_Optimizer"]
],
benchmarks=[
BENCHMARKS["mfh3_good"],
BENCHMARKS["pd1-imagenet-resnet-512"]
],
num_seeds=5,
budget=100,
)
study.optimize()
Command-Line usage
python -m hposuite \
--optimizer RandomSearch Scikit_Optimize \
--benchmark ackley \
--num_seeds 3 \
--budget 50 \
--study_name test_study
View all available Optimizers and Benchmarks
from hposuite.optimizers import OPTIMIZERS
from hposuite.benchmarks import BENCHMARKS
print(OPTIMIZERS.keys())
print(BENCHMARKS.keys())
Results
hposuite saves the Study by default to ../hposuite-output/ (relative to the current working directory).
Results are saved in the Run subdirectories within the main Study directory as .parquet files.
The Study directory and the individual Run directory paths are logged when running Study.optimize()
To view the result dataframe, use the following code snippet:
import pandas as pd
df = pd.read_parquet("<full path to the result .parquet file>")
print(df)
print(df.columns)
Plotting
python -m hposuite.plotting.incumbent_trace \
--study_dir <study directory name> \
--output_dir <abspath of dir where study dir is stored> \
--save_dir <path relative to study_dir to store the plots> \ # optional
--plot_file_name <file_name for saving the plot> \ # optional
--save_dir is set by default to study_dir/plots
--output_dir by default is ../hposuite-output
Overview of available Optimizers
For a more detailed overview, check here
| Optimizer Package | Blackbox | Multi-Fidelity (MF) | Multi-Objective (MO) | Expert Priors |
|---|---|---|---|---|
| RandomSearch | ✓ | ✓ | ||
| RandomSearch with priors | ✓ | ✓ | ✓ | |
| NePS | ✓ | ✓ | ✓ | ✓ |
| SMAC | ✓ | ✓ | ✓ | ✓ |
| DEHB | ✓ | |||
| HEBO | ✓ | |||
| Nevergrad | ✓ | ✓ | ||
| Optuna | ✓ | ✓ | ||
| Scikit-Optimize | ✓ |
Overview of available Benchmarks
For a more detailed overview, check here
| Benchmark Package | Type | Multi-Fidelity | Multi-Objective |
|---|---|---|---|
| Ackley | Synthetic | ||
| Branin | Synthetic | ||
| mf-prior-bench | Synthetic, Surrogate | ✓ | ✓ |
| MF-Hartmann Tabular | Tabular | ✓ | |
| LCBench-Tabular | Tabular | ✓ | ✓ |
| Pymoo | Synthetic | ||
| IOH (BBOB) | Synthetic | ||
| BBOB Tabular | Tabular |
Citation
If you use hposuite for your research, please cite it as below:
@software{Basu_hposuite_2024,
author = {Basu, Soham and Mallik, Neeratyoy and Bergman, Eddie and Hutter, Frank},
title = {hposuite},
year = {2025},
url = {https://github.com/automl/hposuite},
version = {0.1.3}
}
Metadata
Release files for hposuite 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hposuite-0.1.3.tar.gz | 65.2 kB | Without provenance | Details for hposuite-0.1.3.tar.gz |
Release files / hposuite-0.1.3.tar.gz
| Download URL | hposuite-0.1.3.tar.gz |
|---|---|
| Size | 65.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a7cf122aeee1ac58f29cf3614c87ed70ca57d0ccf8f68c0699b889ca32fbddc3
|
|
BLAKE2b-256 checksum How to use checksums |
3141805ec641d829a7634eebd744f313d3c7fe66efbe63729d939f417e60d463
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.12
|
Security for hposuite 0.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.