optuna.structs

该模块已被弃用，其以前的功能移至 optuna.trial 和 optuna.study 。

class optuna.structs.TrialState(value)

Trial 的状态

RUNNING

运行中的 Trial.

COMPLETE

已完成且未触发错误的 Trial.

PRUNED

已经被 TrialPruned 剪枝的 Trial.

FAIL

由于未捕获的错误，该 Trial 已经失败。

1.4.0 版后已移除: 该类已废弃。请改用 TrialState.

class optuna.structs.StudyDirection(value)

Study 的方向。

NOT_SET

方向未设置。

MINIMIZE

Study 将最小化目标函数

MAXIMIZE

Study 将最大化目标函数。

1.4.0 版后已移除: 该类已废弃，请改用 StudyDirection.

class optuna.structs.FrozenTrial(number, state, value, datetime_start, datetime_complete, params, distributions, user_attrs, system_attrs, intermediate_values, trial_id, *, values=None)

警告

在 v1.4.0 中被弃用。该特性将在未来被移除。目前我们计划在 v3.0.0 中移除它，但也可能会改变。参见 https://github.com/optuna/optuna/releases/tag/v1.4.0.

该类已经迁移至 trial, 请改用 FrozenTrial.

参数

• number (int) –

• state (optuna.trial._state.TrialState) –

• value (Optional[float]) –

• datetime_start (Optional[datetime.datetime]) –

• datetime_complete (Optional[datetime.datetime]) –

• params (Dict[str, Any]) –

• distributions (Dict[str, optuna.distributions.BaseDistribution]) –

• user_attrs (Dict[str, Any]) –

• system_attrs (Dict[str, Any]) –

• intermediate_values (Dict[int, float]) –

• trial_id (int) –

• values (Optional[Sequence[float]]) –

返回类型

None

property distributions: Dict[str, optuna.distributions.BaseDistribution]

包含了 params 分布的字典。

property duration: Optional[datetime.timedelta]

返回完成一个 trial 所消耗的时间。

返回

消耗的时间。

property last_step: Optional[int]

返回 trial 中 intermediate_values 的最大步数。

返回

intermediate_values 的最大步数。

report(value, step)

report 函数接口。

由于 FrozenTrial 未被剪枝，该函数将不做任何处理。

参见

Please refer to should_prune().

参数

• value (float) – 目标函数返回的值。

• step (int) – Trial 的步骤（比如，神经网络训练中的 epoch 数）。注意，pruners 假定 step 从零开始计算。比如 MedianPruner 将仅检查 step 是否小于 n_warmup_steps 作为热身机制。

返回类型

None

should_prune()

建议该 trial 是否应该被剪枝。

无论剪枝算法是什么，建议值永远是 False.

备注

FrozenTrial 只对参数组合进行一次采样。

返回

False.

返回类型

bool

class optuna.structs.StudySummary(study_name, direction, best_trial, user_attrs, system_attrs, n_trials, datetime_start, study_id, *, directions=None)

警告

在 v1.4.0 中被弃用。该特性将在未来被移除。目前我们计划在 v3.0.0 中移除它，但也可能会改变。参见 https://github.com/optuna/optuna/releases/tag/v1.4.0.

该类已经迁移到 study, 请改用 StudySummary.

参数

• study_name (str) –

• direction (Optional[optuna._study_direction.StudyDirection]) –

• best_trial (Optional[optuna.trial._frozen.FrozenTrial]) –

• user_attrs (Dict[str, Any]) –

• system_attrs (Dict[str, Any]) –

• n_trials (int) –

• datetime_start (Optional[datetime.datetime]) –

• study_id (int) –

• directions (Optional[Sequence[optuna._study_direction.StudyDirection]]) –