optuna.create_study¶
- optuna.create_study(storage: Union[None, str, storages.BaseStorage] = None, sampler: samplers.BaseSampler = None, pruner: pruners.BasePruner = None, study_name: Optional[str] = None, direction: str = 'minimize', load_if_exists: bool = False) Study [source]¶
Create a new
Study
.- Parameters
storage –
Database URL. If this argument is set to None, in-memory storage is used, and the
Study
will not be persistent.Note
When a database URL is passed, Optuna internally uses SQLAlchemy to handle the database. Please refer to SQLAlchemy’s document for further details. If you want to specify non-default options to SQLAlchemy Engine, you can instantiate
RDBStorage
with your desired options and pass it to thestorage
argument instead of a URL.sampler – A sampler object that implements background algorithm for value suggestion. If
None
is specified,TPESampler
is used as the default. See alsosamplers
.pruner – A pruner object that decides early stopping of unpromising trials. See also
pruners
.study_name – Study’s name. If this argument is set to None, a unique name is generated automatically.
direction – Direction of optimization. Set
minimize
for minimization andmaximize
for maximization.load_if_exists – Flag to control the behavior to handle a conflict of study names. In the case where a study named
study_name
already exists in thestorage
, aDuplicatedStudyError
is raised ifload_if_exists
is set toFalse
. Otherwise, the creation of the study is skipped, and the existing one is returned.
- Returns
A
Study
object.
See also
optuna.create_study()
is an alias ofoptuna.study.create_study()
.