Struct TuiMetricsRendererWrapper 

pub struct TuiMetricsRendererWrapper { /* private fields */ }

Available on crate feature tui only.

The terminal UI metrics renderer.

Implementations

impl TuiMetricsRendererWrapper

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

Create a new terminal UI renderer.

pub fn persistent(self) -> Self

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 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 render_test( &mut self, item: EvaluationProgress, progress_indicators: Vec<ProgressType>, )

Renders the testing progress.

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 render_train( &mut self, item: TrainingProgress, progress_indicators: Vec<ProgressType>, )

Renders the training progress.

fn render_valid( &mut self, item: TrainingProgress, progress_indicators: Vec<ProgressType>, )

Renders the validation progress.

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.