pub struct MetricsCollector { /* private fields */ }Expand description
Metrics collector for tracking multiple optimizers
Implementations§
Source§impl MetricsCollector
impl MetricsCollector
Sourcepub fn register_optimizer(&mut self, name: impl Into<String>)
pub fn register_optimizer(&mut self, name: impl Into<String>)
Register a new optimizer for tracking
Sourcepub fn update<A: Float + ScalarOperand>(
&mut self,
optimizer_name: &str,
step_duration: Duration,
learning_rate: f64,
gradients: &ArrayView1<'_, A>,
params_before: &ArrayView1<'_, A>,
params_after: &ArrayView1<'_, A>,
) -> Result<()>
pub fn update<A: Float + ScalarOperand>( &mut self, optimizer_name: &str, step_duration: Duration, learning_rate: f64, gradients: &ArrayView1<'_, A>, params_before: &ArrayView1<'_, A>, params_after: &ArrayView1<'_, A>, ) -> Result<()>
Update metrics for an optimizer
Sourcepub fn get_metrics(&self, optimizer_name: &str) -> Option<&OptimizerMetrics>
pub fn get_metrics(&self, optimizer_name: &str) -> Option<&OptimizerMetrics>
Get metrics for an optimizer
Sourcepub fn all_metrics(&self) -> &HashMap<String, OptimizerMetrics>
pub fn all_metrics(&self) -> &HashMap<String, OptimizerMetrics>
Get all metrics
Sourcepub fn summary_report(&self) -> String
pub fn summary_report(&self) -> String
Generate summary report
Trait Implementations§
Auto Trait Implementations§
impl Freeze for MetricsCollector
impl RefUnwindSafe for MetricsCollector
impl Send for MetricsCollector
impl Sync for MetricsCollector
impl Unpin for MetricsCollector
impl UnsafeUnpin for MetricsCollector
impl UnwindSafe for MetricsCollector
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
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.