Struct TuiMetricsRendererWrapper 

pub struct TuiMetricsRendererWrapper { /* private fields */ }

The terminal UI metrics renderer.

Implementations

impl TuiMetricsRendererWrapper

pub fn new( interrupter: Interrupter, checkpoint: Option<usize>, ) -> TuiMetricsRendererWrapper

Create a new terminal UI renderer.

pub fn persistent(self) -> TuiMetricsRendererWrapper

Set the renderer to persistent mode.

Trait Implementations

impl Drop for TuiMetricsRendererWrapper

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl EvaluationProgressLogger for TuiMetricsRendererWrapper

fn start_global_progress(&mut self, total_tests: usize)

Called once at the start of evaluation, providing the total number of test splits.

fn start_test(&mut self, _name: &str, total_items: usize)

Called at the start of a test split, providing the split name and total number of items.

fn update_test_progress(&mut self, items_processed: usize)

Log the progress of the current test step.

fn end_test(&mut self)

Called at the end of a test split.

fn end_global_progress(&mut self)

Called at the end of evaluation.

fn log_event_evaluation(&mut self, event: String)

Log a custom named event that falls outside the standard evaluation lifecycle callbacks.

impl MetricsRenderer for TuiMetricsRendererWrapper

fn manual_close(&mut self)

Keep the renderer from automatically closing, requiring manual action to close it.

fn register_metric(&mut self, definition: MetricDefinition)

Register a new metric.

impl MetricsRendererEvaluation for TuiMetricsRendererWrapper

fn update_test(&mut self, name: EvaluationName, state: MetricState)

Updates the testing metric state.

fn on_test_end( &mut self, summary: Option<LearnerSummary>, ) -> Result<(), Box<dyn Error>>

Callback method invoked when testing ends, whether it completed successfully or was interrupted.

impl MetricsRendererTraining for TuiMetricsRendererWrapper

fn update_train(&mut self, state: MetricState)

Updates the training metric state.

fn update_valid(&mut self, state: MetricState)

Updates the validation metric state.

fn on_train_end( &mut self, summary: Option<LearnerSummary>, ) -> Result<(), Box<dyn Error>>

Callback method invoked when training ends, whether it completed successfully or was interrupted.

impl TrainingProgressLogger for TuiMetricsRendererWrapper

fn start( &mut self, total_epochs: usize, starting_epoch: usize, total_items: Option<usize>, label: Option<&str>, )

Called once at the start of training, providing the total number of epochs and the starting epoch.

fn update_epoch(&mut self, epoch: usize)

Called at the end of each full epoch (after both train and valid splits complete).

fn start_split(&mut self, split: &str, total_items: usize)

Called at the start of a training split, providing the split name and total number of items.

fn update_split(&mut self, items_processed: usize)

Log the progress of the current training step.

fn end_split(&mut self)

Called at the end of a training split.

fn end(&mut self)

Called at the end of training, whether it completed successfully or was interrupted.

fn log_event_training(&mut self, event: String)

Log a custom named event that falls outside the standard training lifecycle callbacks.