Skip to main content

MedianPruner

Struct MedianPruner 

Source
pub struct MedianPruner { /* private fields */ }
Expand description

Prunes a trial when its latest intermediate value is worse than the median of other trials’ values at the same step.

Mirrors Optuna’s MedianPruner:

  • No pruning until at least n_startup_trials trials have completed (so the median is meaningful).
  • No pruning before n_warmup_steps steps have elapsed within a trial (give every trial a chance to get past a noisy start).
  • At the current step, compare against the median of the values reported at that same step by trials that reached it; prune if strictly worse.

Implementations§

Source§

impl MedianPruner

Source

pub fn new() -> MedianPruner

A median pruner with default gates (n_startup_trials = 5, n_warmup_steps = 0, min_trials_at_step = 1).

Source

pub fn n_startup_trials(self, n: usize) -> MedianPruner

Number of completed trials required before any pruning happens.

Source

pub fn n_warmup_steps(self, n: usize) -> MedianPruner

Number of steps a trial must run before it becomes eligible for pruning.

Source

pub fn min_trials_at_step(self, n: usize) -> MedianPruner

Minimum number of comparison values required at a step before the median is trusted enough to prune against.

Trait Implementations§

Source§

impl Clone for MedianPruner

Source§

fn clone(&self) -> MedianPruner

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MedianPruner

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MedianPruner

Source§

fn default() -> MedianPruner

Returns the “default value” for a type. Read more
Source§

impl Pruner for MedianPruner

Source§

fn should_prune(&self, study_state: &StudyState, trial: &Trial) -> bool

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.