optuna.study.StudySummary

class optuna.study.StudySummary(study_name, direction, best_trial, user_attrs, system_attrs, n_trials, datetime_start, study_id, *, directions=None)[源代码]

一个 Study 的基本属性和聚合结果。

另请参阅 optuna.study.get_all_study_summaries()。

参数:

study_name (str)
direction (StudyDirection | None)
best_trial (trial.FrozenTrial | None)
user_attrs (dict[str, Any])
system_attrs (dict[str, Any])
n_trials (int)
datetime_start (datetime.datetime | None)
study_id (int)
directions (Sequence[StudyDirection] | None)

study_name: 该 Study 的名称。

direction: StudyDirection 的 Study。

备注

此属性仅在单目标优化期间可用。

directions: 一系列 StudyDirection 对象。

best_trial: optuna.trial.FrozenTrial 在 Study 中具有最佳目标值。

user_attrs: 包含通过 optuna.study.Study.set_user_attr() 设置的 Study 属性的字典。

system_attrs: 包含由 Optuna 内部设置的 Study 属性的字典。

警告

在 v3.1.0 中已弃用。system_attrs 参数将在未来被移除。此功能的移除目前计划在 v5.0.0 进行，但此计划可能会变更。参见 https://github.com/optuna/optuna/releases/tag/v3.1.0。

n_trials: 在 Study 中运行的试验次数。

datetime_start: 开始 Study 的日期时间。

属性

`direction`
`directions`
`system_attrs`