Enum Pruner 

pub enum Pruner {
    Percentile(Percentile),
    Threshold(Threshold),
    Patience(Patience),
}

Whichever of the schemes a pruner is.

Variants

Percentile(Percentile)

Percentile: behind the others.

Threshold(Threshold)

Threshold: past a bound.

Patience(Patience)

Patience: going nowhere.

Implementations

impl Pruner

pub fn verdict(&self, mine: &[f64], others: &[Vec<f64>]) -> Verdict

Continue, or the reason not to. mine is what this trial has reported so far, in order; others the same for those that finished. A step is the n-th report, so trials have to report on the same schedule — true of every pruner that compares across trials, optuna’s included.

Trait Implementations

impl Clone for Pruner

fn clone(&self) -> Pruner

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Pruner

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Pruner

fn fmt(&self, f: &mut Formatter<'_>) -> Result

As text, which is the form that goes into the record of a run. Written by the scheme itself, because the name belongs with the thing it names.

impl From<Patience> for Pruner

fn from(rule: Patience) -> Self

Converts to this type from the input type.

impl From<Percentile> for Pruner

fn from(rule: Percentile) -> Self

Converts to this type from the input type.

impl From<Threshold> for Pruner

fn from(rule: Threshold) -> Self

Converts to this type from the input type.

impl PartialEq for Pruner

fn eq(&self, other: &Pruner) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Pruner