Struct Interrupter 

pub struct Interrupter { /* private fields */ }

A handle that allows aborting the training/evaluation process early.

The process stops either on request, through stop, or because of an error, recorded with fail. An error takes precedence.

Implementations

impl Interrupter

pub fn new() -> Interrupter

Create a new instance.

pub fn stop(&self, reason: Option<&str>)

Notify the learner that it should stop.

Arguments

• reason - A string describing the reason the training was stopped.

pub fn fail(&self, error: impl Into<TrainingError>)

Stop the process and keep error as the cause.

The first call to this function logs the error and keeps it as the cause of the interruption. Subsequent calls only log the errors as they are most likely consequences of the first one.

pub fn fail_on_error<E>(&self, result: Result<(), E>)

where E: Into<TrainingError>,

fail with result’s error if there is one.

pub fn reset(&self)

Reset the interrupter, forgetting any stop and error.

pub fn should_stop(&self) -> bool

True if the process should stop: stop or fail was called.

pub fn interruption(&self) -> Option<Interruption>

The stop, if the process was stopped without an error.

pub fn error(&self) -> Option<Arc<TrainingError>>

The error the process stopped on, if fail was called.

pub fn get_message(&self) -> Option<String>

Get the message associated with the interrupt.

Trait Implementations

impl Clone for Interrupter

fn clone(&self) -> Interrupter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Interrupter

fn default() -> Interrupter

Returns the “default value” for a type.