Enum TrainerError 

pub enum TrainerError {
    Step(StepError),
    EmptyBatch,
    Observer {
        step_index: usize,
        steps_processed: usize,
        cause: String,
    },
    InvalidSample {
        index: usize,
        reason: SampleInvariant,
    },
}

Errors from batch training sessions.

Variants

Step(StepError)

Underlying network step failed.

EmptyBatch

run_session was called with an empty batch.

Empty is a batch-level condition (no sample index). The network, trainer config, and any caller-owned metrics are left untouched.

Observer

A per-step observer returned an error after a successful network step.

The network update for step_index has already been applied. No further example is processed (abort-before-next-step). steps_processed counts completed network steps, including the one whose observer then failed.

Fields

step_index: usize

0-based index of the example whose observer call failed.

steps_processed: usize

Number of successful network steps before aborting (includes the failing observer’s step).

cause: String

Display form of the observer’s error.

InvalidSample

Preflight rejected the batch because sample index violated reason.

No earlier sample has been applied; trainer and network state are unchanged.

Fields

index: usize

Zero-based index into the batch slice.

reason: SampleInvariant

Which admission invariant failed.

Trait Implementations

impl Clone for TrainerError

fn clone(&self) -> TrainerError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrainerError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for TrainerError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for TrainerError

impl Error for TrainerError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl PartialEq for TrainerError

fn eq(&self, other: &TrainerError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TrainerError