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_trialstrials have completed (so the median is meaningful). - No pruning before
n_warmup_stepssteps 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
impl MedianPruner
Sourcepub fn new() -> MedianPruner
pub fn new() -> MedianPruner
A median pruner with default gates (n_startup_trials = 5,
n_warmup_steps = 0, min_trials_at_step = 1).
Sourcepub fn n_startup_trials(self, n: usize) -> MedianPruner
pub fn n_startup_trials(self, n: usize) -> MedianPruner
Number of completed trials required before any pruning happens.
Sourcepub fn n_warmup_steps(self, n: usize) -> MedianPruner
pub fn n_warmup_steps(self, n: usize) -> MedianPruner
Number of steps a trial must run before it becomes eligible for pruning.
Sourcepub fn min_trials_at_step(self, n: usize) -> MedianPruner
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
impl Clone for MedianPruner
Source§fn clone(&self) -> MedianPruner
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)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for MedianPruner
impl Debug for MedianPruner
Source§impl Default for MedianPruner
impl Default for MedianPruner
Source§fn default() -> MedianPruner
fn default() -> MedianPruner
Returns the “default value” for a type. Read more
Source§impl Pruner for MedianPruner
impl Pruner for MedianPruner
fn should_prune(&self, study_state: &StudyState, trial: &Trial) -> bool
Auto Trait Implementations§
impl Freeze for MedianPruner
impl RefUnwindSafe for MedianPruner
impl Send for MedianPruner
impl Sync for MedianPruner
impl Unpin for MedianPruner
impl UnsafeUnpin for MedianPruner
impl UnwindSafe for MedianPruner
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more