Skip to content

Storage

sklearn_optuna.optuna.Storage

Bases: BaseClassWrapper

Wrapper for Optuna storage backends for optimization history.

Parameters

Name Type Description Default
storage type

Optuna storage class to instantiate.

 optuna.storages.RDBStorage
**params dict

Parameters to pass to the storage constructor.

 {}

See Also

Source Code

View on GitHub

Source code in src/sklearn_optuna/optuna.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
class Storage(BaseClassWrapper):
    """Wrapper for Optuna storage backends for optimization history.

    Parameters
    ----------
    storage : type, default=optuna.storages.RDBStorage
        Optuna storage class to instantiate.

    **params : dict
        Parameters to pass to the storage constructor.

    See Also
    --------
    sklearn_optuna.search.OptunaSearchCV : The main search class that uses storage.
    sklearn_optuna.optuna.Sampler : Wrapper for Optuna samplers.
    """

    _estimator_name = "storage"
    _estimator_base_class = optuna.storages.BaseStorage
    _estimator_default_class = optuna.storages.RDBStorage

    def __init__(self, storage: type = optuna.storages.RDBStorage, **params) -> None:
        super().__init__(storage=storage, **params)