optuna.pruners
The ~optuna.pruners
module defines a ~optuna.pruners.BasePruner
class characterized by an abstract ~optuna.pruners.BasePruner.prune
method, which, for a given trial and its associated study, returns a boolean value representing whether the trial should be pruned. This determination is made based on stored intermediate values of the objective function, as previously reported for the trial using optuna.trial.Trial.report
. The remaining classes in this module represent child classes, inheriting from ~optuna.pruners.BasePruner
, which implement different pruning strategies.
Warning
Currently ~optuna.pruners
module is expected to be used only for single-objective optimization.
pruning
tutorial explains the concept of the pruner classes and a minimal example.
user_defined_pruner
tutorial could be helpful if you want to implement your own pruner classes.
optuna.pruners.BasePruner optuna.pruners.MedianPruner optuna.pruners.NopPruner optuna.pruners.PatientPruner optuna.pruners.PercentilePruner optuna.pruners.SuccessiveHalvingPruner optuna.pruners.HyperbandPruner optuna.pruners.ThresholdPruner optuna.pruners.WilcoxonPruner