Skip to main content

OptunaHub

Project description

OptunaHub: A Platform for Black-Box Optimization

OptunaHub

Python pypi GitHub license Codecov

:link: OptunaHub | :page_with_curl: Docs | :book: Tutorials | :question: FAQ | Optuna.org

OptunaHub is a platform for black-box optimizaiton. On the basis of Optuna, a powerful and flexible black-box optimization framework, OptunaHub provides implementations of state-of-the-art optimization algorithms and visualization of optimization results for analysis. You can also publish your algorithm implementation on the platform and make it available to Optuna users around the world.

This is the repository of the optunahub Python Library to use packages published in OptunaHub. If you would like to register your package in OptunaHub, please contribute by creating a pull request to the optunahub-registry repository.

:loudspeaker: News

Installation

OptunaHub is available at the Python Package Index.

pip install optunahub

It is also available at conda-forge.

conda install -c conda-forge optunahub

Example

You only need to search for the desired function on the OptunaHub website and call the optunahub.load_module function in your code to incorporate it.

import optuna
import optunahub


def objective(trial: optuna.Trial) -> float:
  x = trial.suggest_float("x", -5, 5)
  y = trial.suggest_float("y", -5, 5)
  return x**2 + y**2


module = optunahub.load_module(package="samplers/auto_sampler")
study = optuna.create_study(sampler=module.AutoSampler())
study.optimize(objective, n_trials=10)

print(study.best_trial.value, study.best_trial.params)

Contribution

Any contributions to OptunaHub are more than welcome!

OptunaHub is composed of the following three related repositories. Please contribute to the appropriate repository for your purposes.

  • optunahub (this repository)
    • The python library to use OptunaHub. If you find issues and/or bugs in the optunahub library, please report it here via Github issues.
  • optunahub-registry
    • The registry of the OptunaHub packages. If you are interested in registering your package with OptunaHub, please contribute to this repository. For general guidelines on how to contribute to the repository, take a look at CONTRIBUTING.md.
  • optunahub-web
    • The web frontend for OptunaHub. If you find issues and/or bugs on the website, please report it here via GitHub issues.

License

MIT License (see LICENSE).

Citation

Please cite the OptunaHub paper with the following format when you use it in your project:

@article{ozaki2025optunahub,
  title={{OptunaHub}: A Platform for Black-Box Optimization},
  author={Ozaki, Yoshihiko and Watanabe, Shuhei and Yanase, Toshihiko},
  journal={arXiv preprint arXiv:2510.02798},
  year={2025}
}

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

optunahub-0.4.0.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

optunahub-0.4.0-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file optunahub-0.4.0.tar.gz.

File metadata

  • Download URL: optunahub-0.4.0.tar.gz
  • Upload date:
  • Size: 14.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for optunahub-0.4.0.tar.gz
Algorithm Hash digest
SHA256 aa9cf98884b764b4cc8ad004b3b159eb6ed6249823e4bf0a5637b27ce185001a
MD5 5be6c3bd2d6c3abcdf75ac7f674156e5
BLAKE2b-256 3b844450d4379b7171463982471f52d3c47f59ec1a41b23730633976e66f7632

See more details on using hashes here.

File details

Details for the file optunahub-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: optunahub-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for optunahub-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 29cf922111407938ad4876aa2c27b40df700669787dee95a2c09905874be7261
MD5 806123faaa9e42726d1d7d11256ef2c1
BLAKE2b-256 db6cac8b2599b1b526552661cfc5b5674d24e97e71cea2afe8ca4f427345d3a5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page