optuna.terminator.TerminatorCallback

class optuna.terminator.TerminatorCallback(terminator=None)[source]

Terminator を使用して最適化を終了するコールバック。

このクラスは、Terminator をラップし、 optimize() メソッドで使用できるようにしたコールバックを実装しています。

Parameters:

terminator (BaseTerminator | None) – 最適化の終了判定を行う Terminator オブジェクト。デフォルトでは、デフォルトの improvement_evaluatorerror_evaluator を持つ Terminator オブジェクトが使用されます。

使用例

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 TerminatorCallback
from optuna.terminator import report_cross_validation_scores


def objective(trial):
    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)
    return scores.mean()


study = optuna.create_study(direction="maximize")
terminator = TerminatorCallback()
study.optimize(objective, n_trials=50, callbacks=[terminator])

See also

終了判定の詳細については Terminator を参照してください。

Note

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