Hydra sweeper integration of our favorite optimization packages, utilizing ask-and-tell interfaces.
Project description
HyperSweeper
Hydra sweeper integration of our favorite optimization packages, utilizing ask-and-tell interfaces.
- Free software: BSD license
- Documentation: https://automl.github.io/hypersweeper
Installation
We recommend installing hypersweeper via a uv virtual environment:
pip install uv
uv venv --python 3.10
make install
For extra dependencies, add them like this:
uv sync --extra dev --extra carps
Basic Usage
To use the sweeper, you need to specify a target function with a hydra interface (see our examples). Then you can add one of the Hypersweeper variations as a sweeper and run with the '-m' flag to start the optimization. This will start a sequential run of your selected optimizer. If you want to use Hypersweeper on a cluster, you should additionally add a launcher, e.g. the submitit launcher for slurm.
As an example, take black-box optimization for Branin using SMAC. Simply run:
python examples/branin.py -m
You should see the launched configurations in the terminal. The results are located in 'tmp', including a record of each run, the final config and a full runhistory. For more information, see our example ReadMe.
Current Sweeper Integrations
- Random Search
- SMAC
- HEBO
- PBT
- CARP-S (which contains many different optimizers in itself)
Cite Us
If you use Hypersweeper in your project, please cite us:
@misc{eimer24,
author = {T. Eimer},
title = {Hypersweeper},
year = {2024},
url = {https://github.com/automl/hypersweeper},
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hypersweeper-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e196afc0e2901fa254b7187a35310cb6f289ac79df9dba290f7a0372306b2114 |
|
MD5 | 77c0eb23733edec2c8b685cc9e0a478e |
|
BLAKE2b-256 | 89e9dad04f98ae1704bb4c276026661f76c2d22712169c885af85f24d8e6e523 |