optuna.terminator.Terminator

class optuna.terminator.Terminator(improvement_evaluator=None, error_evaluator=None, min_n_trials=20)[source]

Optuna スタディの自動停止機構

このクラスは Optuna スタディの自動停止機構を実装しており、不要な計算を防ぐことを目的としています。 統計的誤差(例:交差検証誤差)が最適化の余地を超えた時点でスタディが終了します。

アルゴリズムの詳細については、以下の論文を参照してください:

Parameters:
  • improvement_evaluator (BaseImprovementEvaluator | None) – 最適化の余地を評価する評価器オブジェクト。デフォルトでは RegretBoundEvaluator オブジェクトが使用されます。

  • error_evaluator (BaseErrorEvaluator | None) – 統計的誤差(例:交差検証誤差)を計算する評価器。デフォルトでは CrossValidationErrorEvaluator オブジェクトが使用されます。

  • min_n_trials (int) – 終了判定の基準となる最小試行回数。デフォルトは 20 です。

Raises:

ValueErrormin_n_trials が正の整数でない場合

使用例

import logging
import sys

from sklearn.datasets import load_wine
from sklearn.ensemble import RandomForestClassifier
from sklearn.model_selection import cross_val_score
from sklearn.model_selection import KFold

import optuna
from optuna.terminator import Terminator
from optuna.terminator import report_cross_validation_scores


study = optuna.create_study(direction="maximize")
terminator = Terminator()
min_n_trials = 20

while True:
    trial = study.ask()

    X, y = load_wine(return_X_y=True)

    clf = RandomForestClassifier(
        max_depth=trial.suggest_int("max_depth", 2, 32),
        min_samples_split=trial.suggest_float("min_samples_split", 0, 1),
        criterion=trial.suggest_categorical("criterion", ("gini", "entropy")),
    )

    scores = cross_val_score(clf, X, y, cv=KFold(n_splits=5, shuffle=True))
    report_cross_validation_scores(trial, scores)

    value = scores.mean()
    logging.info(f"試行 #{trial.number} は値 {value} で終了しました。")
    study.tell(trial, value)

    if trial.number > min_n_trials and terminator.should_terminate(study):
        logging.info("Optuna Terminator により終了しました。")
        break

See also

optimize() メソッドでこのターミネーターを使用する方法については、 TerminatorCallback を参照してください。

Note

v3.2.0 で実験的機能として追加されました。インターフェースは予告なく変更される可能性があります。 詳細は https://github.com/optuna/optuna/releases/tag/v3.2.0 を参照してください。

メソッド

should_terminate(study)

Judge whether the study should be terminated based on the reported values.

should_terminate(study)[source]

報告された値に基づいてスタディを終了すべきかどうかを判定します。

Parameters:

study (Study)

Return type:

bool