optuna.terminator

The terminator module implements a mechanism for automatically terminating the optimization process, accompanied by a callback class for the termination and evaluators for the estimated room for improvement in the optimization and statistical error of the objective function. The terminator stops the optimization process when the estimated potential improvement is smaller than the statistical error.

optuna.terminator.BaseTerminator

Base class for terminators.

optuna.terminator.Terminator

Automatic stopping mechanism for Optuna studies.

optuna.terminator.BaseImprovementEvaluator

Base class for improvement evaluators.

optuna.terminator.RegretBoundEvaluator

An error evaluator for upper bound on the regret with high-probability confidence.

optuna.terminator.BestValueStagnationEvaluator

Evaluates the stagnation period of the best value in an optimization process.

optuna.terminator.BaseErrorEvaluator

Base class for error evaluators.

optuna.terminator.CrossValidationErrorEvaluator

An error evaluator for objective functions based on cross-validation.

optuna.terminator.StaticErrorEvaluator

An error evaluator that always returns a constant value.

optuna.terminator.TerminatorCallback

A callback that terminates the optimization using Terminator.

optuna.terminator.report_cross_validation_scores

A function to report cross-validation scores of a trial.

For an example of using this module, please refer to this example.