Struct NumericMetricState 

pub struct NumericMetricState { /* private fields */ }

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

pub fn new() -> NumericMetricState

Create a new numeric metric state.

pub fn reset(&mut self)

Reset the state.

pub fn update(&mut self, value: f64, count: usize)

Update the state.

count is the number of underlying units value is averaged over. This is typically the batch size (e.g. for accuracy, loss), but it can be any unit the metric’s value is implicitly a rate over. A zero-count update records the current value without changing the running aggregate.

pub fn compute_update(&self, format: FormatOptions) -> SerializedEntry

Compute the metric for the current update.

pub fn compute_final(&self, format: FormatOptions) -> SerializedEntry

Compute the final metric for the accumulated global state.

pub fn current_value(&self) -> NumericEntry

Get the numeric value.

pub fn running_value(&self) -> NumericEntry

Get the running aggregated value.

pub fn final_value(&self) -> NumericEntry

Get the final aggregated value.

Trait Implementations

impl Clone for NumericMetricState

fn clone(&self) -> NumericMetricState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for NumericMetricState

fn default() -> NumericMetricState

Returns the “default value” for a type.