Struct CliMetricsRenderer
pub struct CliMetricsRenderer { /* private fields */ }Expand description
A simple renderer for when the cli feature is not enabled.
Implementations§
§impl CliMetricsRenderer
impl CliMetricsRenderer
pub fn new() -> CliMetricsRenderer
pub fn new() -> CliMetricsRenderer
Create a new instance.
Trait Implementations§
§impl EvaluationProgressLogger for CliMetricsRenderer
impl EvaluationProgressLogger for CliMetricsRenderer
§fn start_global_progress(&mut self, total_tests: usize)
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)
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)
fn update_test_progress(&mut self, items_processed: usize)
Log the progress of the current test step.
§fn end_global_progress(&mut self)
fn end_global_progress(&mut self)
Called at the end of evaluation.
§fn log_event_evaluation(&mut self, _event: String)
fn log_event_evaluation(&mut self, _event: String)
Log a custom named event that falls outside the standard evaluation lifecycle callbacks.
§impl MetricsRenderer for CliMetricsRenderer
impl MetricsRenderer for CliMetricsRenderer
§fn manual_close(&mut self)
fn manual_close(&mut self)
Keep the renderer from automatically closing, requiring manual action to close it.
§fn register_metric(&mut self, _definition: MetricDefinition)
fn register_metric(&mut self, _definition: MetricDefinition)
Register a new metric.
§impl MetricsRendererEvaluation for CliMetricsRenderer
impl MetricsRendererEvaluation for CliMetricsRenderer
§fn update_test(&mut self, _name: EvaluationName, _state: MetricState)
fn update_test(&mut self, _name: EvaluationName, _state: MetricState)
Updates the testing metric state. Read more
§fn on_test_end(
&mut self,
summary: Option<LearnerSummary>,
) -> Result<(), Box<dyn Error>>
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. Read more
§impl MetricsRendererTraining for CliMetricsRenderer
impl MetricsRendererTraining for CliMetricsRenderer
§fn update_train(&mut self, _state: MetricState)
fn update_train(&mut self, _state: MetricState)
Updates the training metric state. Read more
§fn update_valid(&mut self, _state: MetricState)
fn update_valid(&mut self, _state: MetricState)
Updates the validation metric state. Read more
§fn on_train_end(
&mut self,
summary: Option<LearnerSummary>,
) -> Result<(), Box<dyn Error>>
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. Read more
§impl TrainingProgressLogger for CliMetricsRenderer
impl TrainingProgressLogger for CliMetricsRenderer
§fn start(
&mut self,
total_epochs: usize,
starting_epoch: usize,
total_items: Option<usize>,
label: Option<&str>,
)
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. Read more
§fn start_split(&mut self, split_name: &str, total_items: usize)
fn start_split(&mut self, split_name: &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)
fn update_split(&mut self, items_processed: usize)
Log the progress of the current training step.
§fn update_epoch(&mut self, epoch: usize)
fn update_epoch(&mut self, epoch: usize)
Called at the end of each full epoch (after both train and valid splits complete).
§fn end(&mut self)
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)
fn log_event_training(&mut self, _event: String)
Log a custom named event that falls outside the standard training lifecycle callbacks.
Auto Trait Implementations§
impl Freeze for CliMetricsRenderer
impl RefUnwindSafe for CliMetricsRenderer
impl Send for CliMetricsRenderer
impl Sync for CliMetricsRenderer
impl Unpin for CliMetricsRenderer
impl UnsafeUnpin for CliMetricsRenderer
impl UnwindSafe for CliMetricsRenderer
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
§impl<K, Q> Comparable<Q> for K
impl<K, Q> Comparable<Q> for K
§impl<K, Q> Equivalent<Q> for K
impl<K, Q> Equivalent<Q> for K
§fn equivalent(&self, key: &Q) -> bool
fn equivalent(&self, key: &Q) -> bool
Compare self to
key and return true if they are equal.impl<T> ErasedDestructor for Twhere
T: 'static,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more