Struct MetricsLogger 

pub struct MetricsLogger { /* private fields */ }

Metrics logger that aggregates and logs training metrics.

Collects metrics and logs them using multiple backends.

Implementations

impl MetricsLogger

pub fn new() -> Self

Create a new metrics logger.

pub fn add_backend<B: LoggingBackend + Clone + Debug + 'static>( &mut self, backend: B, )

Add a logging backend.

Arguments

• backend - Backend to add

pub fn log_metric(&mut self, name: &str, value: f64) -> TrainResult<()>

Log a scalar metric to all backends.

Arguments

• name - Metric name
• value - Metric value

pub fn accumulate_metric(&mut self, name: &str, value: f64)

Accumulate a metric value (for averaging over batch).

Arguments

• name - Metric name
• value - Metric value

pub fn log_accumulated_metrics(&mut self) -> TrainResult<()>

Log accumulated metrics (average) and clear accumulation.

pub fn log_message(&mut self, message: &str) -> TrainResult<()>

Log a text message to all backends.

Arguments

• message - Text message

pub fn step(&mut self)

Increment the step counter.

pub fn set_step(&mut self, step: usize)

Set the current step.

Arguments

• step - Step number

pub fn current_step(&self) -> usize

Get the current step.

pub fn flush(&mut self) -> TrainResult<()>

Flush all backends.

pub fn num_backends(&self) -> usize

Get the number of backends.

Trait Implementations

impl Debug for MetricsLogger

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MetricsLogger

fn default() -> Self

Returns the “default value” for a type.