Struct burn::train::metric::state::NumericMetricState
pub struct NumericMetricState { /* private fields */ }Expand description
Useful utility to implement numeric metrics.
§Notes
The numeric metric store values inside floats. Even if some metric are integers, their mean are floats.
Implementations§
§impl NumericMetricState
impl NumericMetricState
pub fn new() -> NumericMetricState
pub fn new() -> NumericMetricState
Create a new numeric metric state.
pub fn reset(&mut self)
pub fn reset(&mut self)
Reset the state.
pub fn update(
&mut self,
value: f64,
batch_size: usize,
format: FormatOptions,
) -> MetricEntry
pub fn update( &mut self, value: f64, batch_size: usize, format: FormatOptions, ) -> MetricEntry
Update the state.
Trait Implementations§
§impl Default for NumericMetricState
impl Default for NumericMetricState
§fn default() -> NumericMetricState
fn default() -> NumericMetricState
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for NumericMetricState
impl RefUnwindSafe for NumericMetricState
impl Send for NumericMetricState
impl Sync for NumericMetricState
impl Unpin for NumericMetricState
impl UnwindSafe for NumericMetricState
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<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
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 more§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as
ReadEndian::read_from_little_endian().