MetricLogger

burn::train::logger

Trait MetricLogger 

pub trait MetricLogger: Send {
    // Required methods
    fn log(
        &mut self,
        update: MetricsUpdate,
        epoch: usize,
        split: Split,
        tag: Option<Arc<String>>,
    );
    fn read_numeric(
        &mut self,
        name: &str,
        epoch: usize,
        split: Split,
    ) -> Result<Vec<NumericEntry>, String>;
    fn log_metric_definition(&mut self, definition: MetricDefinition);
    fn log_epoch_summary(&mut self, summary: EpochSummary);
}
Expand description

Metric logger.

Required Methods§

fn log( &mut self, update: MetricsUpdate, epoch: usize, split: Split, tag: Option<Arc<String>>, )

Logs an item.

§Arguments
  • update - Update information for all registered metrics.
  • epoch - Current epoch.
  • split - Current dataset split.
  • iteration - Current iteration.
  • tag - Optional, additional tag for the split.

fn read_numeric( &mut self, name: &str, epoch: usize, split: Split, ) -> Result<Vec<NumericEntry>, String>

Read the logs for an epoch.

fn log_metric_definition(&mut self, definition: MetricDefinition)

Logs the metric definition information (name, description, unit, etc.)

fn log_epoch_summary(&mut self, summary: EpochSummary)

Logs summary at the end of the epoch.

Implementors§