pub struct MetricOptimizer<F: Float + Debug + Display + FromPrimitive = f64> { /* private fields */ }Expand description
Adapter for using scirs2-metrics with scirs2-optim
Implementations§
Source§impl<F: Float + Debug + Display + FromPrimitive> MetricOptimizer<F>
impl<F: Float + Debug + Display + FromPrimitive> MetricOptimizer<F>
Sourcepub fn new<S: Into<String>>(name: S, maximize: bool) -> Self
pub fn new<S: Into<String>>(name: S, maximize: bool) -> Self
Create a new metric optimizer
§Arguments
metric_name- Name of the metric to optimizemaximize- Whether to maximize (true) or minimize (false) the metric
Sourcepub fn metric_name(&self) -> &str
pub fn metric_name(&self) -> &str
Get the metric name
Sourcepub fn mode(&self) -> OptimizationMode
pub fn mode(&self) -> OptimizationMode
Get the optimization mode
Sourcepub fn best_value(&self) -> Option<F>
pub fn best_value(&self) -> Option<F>
Get the best metric value seen so far
Sourcepub fn add_additional_value(&mut self, metricname: &str, value: F)
pub fn add_additional_value(&mut self, metricname: &str, value: F)
Add a value for an additional metric to track
Sourcepub fn additional_metric_history(&self, metricname: &str) -> Option<&[F]>
pub fn additional_metric_history(&self, metricname: &str) -> Option<&[F]>
Get the history of an additional metric
Sourcepub fn is_better(&self, current: F, previous: F) -> bool
pub fn is_better(&self, current: F, previous: F) -> bool
Check if the current value is better than the previous best
Sourcepub fn is_improvement(&self, value: F) -> bool
pub fn is_improvement(&self, value: F) -> bool
Check if the current metric value is better than the best so far
Sourcepub fn create_scheduler_config(
&self,
initial_lr: F,
factor: F,
patience: usize,
min_lr: F,
) -> SchedulerConfig<F>
pub fn create_scheduler_config( &self, initial_lr: F, factor: F, patience: usize, min_lr: F, ) -> SchedulerConfig<F>
Create scheduler configuration for this metric
Returns a configuration that can be used to create an external scheduler. This provides a bridge to scirs2-optim schedulers without circular dependencies.
Trait Implementations§
Source§impl<F: Clone + Float + Debug + Display + FromPrimitive> Clone for MetricOptimizer<F>
impl<F: Clone + Float + Debug + Display + FromPrimitive> Clone for MetricOptimizer<F>
Source§fn clone(&self) -> MetricOptimizer<F>
fn clone(&self) -> MetricOptimizer<F>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl<F> Freeze for MetricOptimizer<F>where
F: Freeze,
impl<F> RefUnwindSafe for MetricOptimizer<F>where
F: RefUnwindSafe,
impl<F> Send for MetricOptimizer<F>where
F: Send,
impl<F> Sync for MetricOptimizer<F>where
F: Sync,
impl<F> Unpin for MetricOptimizer<F>where
F: Unpin,
impl<F> UnwindSafe for MetricOptimizer<F>where
F: UnwindSafe,
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.