Skip to main content

Optuna-Integration

Python pypi conda GitHub license Codecov Read the Docs

This package is an integration module of Optuna, an automatic Hyperparameter optimization software framework. The modules in this package provide users with extended functionalities for Optuna in combination with third-party libraries such as PyTorch, sklearn, and TensorFlow.

[!NOTE] You can find more information in our official documentations and API reference.

Installation

Optuna-Integration is available via pip and on conda.

# PyPI
$ pip install optuna-integration

# Anaconda Cloud
$ conda install -c conda-forge optuna-integration

[!IMPORTANT] As dependencies of all the modules are large and complicated, the commands above install only the common dependencies. Dependencies for each module can be installed via pip. For example, if you would like to install the dependencies of optuna_integration.botorch and optuna_integration.lightgbm, you can install them via:

$ pip install optuna-integration[botorch,lightgbm]

[!NOTE] Optuna-Integration supports from Python 3.8 to Python 3.12. Optuna Docker image is also provided at DockerHub.

Integration Modules

Here is the table of optuna-integration modules:

Third Party Library Example
BoTorch Unavailable
CatBoost CatBoostPruningCallback
Dask DaskStorage
FastAI FastAIPruningCallback
Keras KerasPruningCallback
LightGBM LightGBMPruningCallback / LightGBMTuner
MLflow MLflowCallback
MXNet Unavailable
PyTorch Distributed TorchDistributedTrial
PyTorch Ignite PyTorchIgnitePruningHandler
PyTorch Lightning PyTorchLightningPruningCallback
pycma Unavailable
SHAP Unavailable
scikit-learn OptunaSearchCV
skorch SkorchPruningCallback
TensorBoard TensorBoardCallback
tf.keras TFKerasPruningCallback
Weights & Biases WeightsAndBiasesCallback
XGBoost XGBoostPruningCallback
AllenNLP* AllenNLPPruningCallback
Chainer* ChainerPruningExtension
ChainerMN* ChainerMNStudy

[!WARNING] * shows deprecated modules and they might be removed in the future.

Communication

Contribution

Any contributions to Optuna-Integration are more than welcome!

For general guidelines how to contribute to the project, take a look at CONTRIBUTING.md.

Reference

If you use Optuna in one of your research projects, please cite our KDD paper "Optuna: A Next-generation Hyperparameter Optimization Framework":

BibTeX
@inproceedings{akiba2019optuna,
  title={{O}ptuna: A Next-Generation Hyperparameter Optimization Framework},
  author={Akiba, Takuya and Sano, Shotaro and Yanase, Toshihiko and Ohta, Takeru and Koyama, Masanori},
  booktitle={The 25th ACM SIGKDD International Conference on Knowledge Discovery \& Data Mining},
  pages={2623--2631},
  year={2019}
}

Metadata

Release files for optuna-integration 4.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for optuna-integration 4.2.1
File Size Uploaded
optuna_integration-4.2.1.tar.gz 85.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for optuna-integration 4.2.1
File Interpreter ABI Platform
optuna_integration-4.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 182.6 kB

Release files / optuna_integration-4.2.1.tar.gz

Download URL optuna_integration-4.2.1.tar.gz
Size 85.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4abff66014b23c578bd656595769cb446664812b2dfecc0dc2e38af4c03ddc12
BLAKE2b-256 checksum
How to use checksums
b6a8cb4c69264490b3ce4334db38e6fd6809be71d12d4a91b287d8d21ed1cedd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

Release files / optuna_integration-4.2.1-py3-none-any.whl

Download URL optuna_integration-4.2.1-py3-none-any.whl
Size 97.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f45c38750cb1a41401731603cd286c8435b0a8baec0c07e63a51fdd5e1ae8031
BLAKE2b-256 checksum
How to use checksums
fb7296fb1f0b6c72af7d2a5c3029f864d38eda47150c939510b9a9f5abf143db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

Release history Release notifications | RSS feed

5.0.0

2 release files

4.9.0

2 release files

4.8.0

2 release files

4.7.0

2 release files

4.6.0

2 release files

4.5.0

2 release files

4.4.0

2 release files

4.3.0

2 release files

This release

4.2.1 This release

2 release files

4.2.0

2 release files

4.1.0

2 release files

4.0.0

2 release files

3.6.0

2 release files

3.5.0

2 release files

3.4.0

2 release files

3.3.0

2 release files

3.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page