Configs

siapy.optimizers.configs

CreateStudyConfig

Bases: BaseModel

model_config class-attribute instance-attribute

model_config = ConfigDict(arbitrary_types_allowed=True)

storage class-attribute instance-attribute

storage: str | BaseStorage | None = None

sampler class-attribute instance-attribute

sampler: BaseSampler | None = None

pruner class-attribute instance-attribute

pruner: BasePruner | None = None

study_name class-attribute instance-attribute

study_name: str | None = None

direction class-attribute instance-attribute

direction: Literal['maximize', 'minimize'] | StudyDirection | None = 'minimize'

load_if_exists class-attribute instance-attribute

load_if_exists: bool = False

OptimizeStudyConfig

Bases: BaseModel

model_config class-attribute instance-attribute

model_config = ConfigDict(arbitrary_types_allowed=True)

n_trials class-attribute instance-attribute

n_trials: int | None = None

timeout class-attribute instance-attribute

timeout: float | None = None

n_jobs class-attribute instance-attribute

n_jobs: int = -1

catch class-attribute instance-attribute

catch: Iterable[type[Exception]] | type[Exception] = ()

callbacks class-attribute instance-attribute

callbacks: list[Callable[[Study, FrozenTrial], None]] | None = None

gc_after_trial class-attribute instance-attribute

gc_after_trial: bool = False

show_progress_bar class-attribute instance-attribute

show_progress_bar: bool = True

TabularOptimizerConfig

Bases: BaseModel

model_config class-attribute instance-attribute

model_config = ConfigDict(arbitrary_types_allowed=True)

create_study class-attribute instance-attribute

create_study: CreateStudyConfig = CreateStudyConfig()

optimize_study class-attribute instance-attribute

optimize_study: OptimizeStudyConfig = OptimizeStudyConfig()

scorer class-attribute instance-attribute

scorer: Scorer | None = None

trial_parameters class-attribute instance-attribute

trial_parameters: TrialParameters | None = None