Class BasePruner

Namespace

OptunaSharp.Pruners

Assembly

OptunaSharp.dll

Base class for pruners. Port of optuna/pruners/_base.py: BasePruner.

public abstract class BasePruner

Inheritance

object

BasePruner

Derived

HyperbandPruner

NopPruner

PatientPruner

PercentilePruner

SuccessiveHalvingPruner

ThresholdPruner

WilcoxonPruner

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Prune(Study, FrozenTrial)

Judge whether the trial should be pruned based on the reported values.

Note that this method is not supposed to be called by library users. Instead, Report(double, long) and ShouldPrune() provide user interfaces to implement pruning mechanism in an objective function.

public abstract bool Prune(Study study, FrozenTrial trial)

Parameters

study Study

Study object of the target study.

trial FrozenTrial

FrozenTrial object of the target trial. Take a copy before modifying this object.

Returns

bool

A boolean value representing whether the trial should be pruned.