optuna.study.get_all_study_summaries

optuna.study.get_all_study_summaries(storage, include_best_trial=True)[source]

指定したストレージに保存されているスタディの全履歴を取得します。

使用例

import optuna


def objective(trial):
    x = trial.suggest_float("x", -10, 10)
    return (x - 2) ** 2


study = optuna.create_study(study_name="example-study", storage="sqlite:///example.db")
study.optimize(objective, n_trials=3)

study_summaries = optuna.study.get_all_study_summaries(storage="sqlite:///example.db")
assert len(study_summaries) == 1

study_summary = study_summaries[0]
assert study_summary.study_name == "example-study"

Parameters:

storage (str | BaseStorage) – sqlite:///example.db のようなデータベース URL。詳細は create_study() のドキュメントも参照してください。
include_best_trial (bool) – 最良のトライアルを含めるかどうか。存在する場合、クエリ数が増加し、ストレージによっては要約の取得に時間がかかる可能性があります。

Returns:

StudySummary オブジェクトとして要約されたスタディ履歴のリスト。

Return type:

list[StudySummary]