Enum OptimError 

pub enum OptimError {
    InvalidLearningRate {
        lr: f32,
    },
    InvalidMomentum {
        momentum: f32,
    },
    InvalidBeta1 {
        beta1: f32,
    },
    InvalidBeta2 {
        beta2: f32,
    },
    InvalidEpsilon {
        epsilon: f32,
    },
    InvalidRmsPropAlpha {
        alpha: f32,
    },
    InvalidStepGamma {
        gamma: f32,
    },
    InvalidStepSize {
        step_size: usize,
    },
    InvalidCosineTMax {
        t_max: usize,
    },
    InvalidWarmupSteps {
        warmup_steps: usize,
    },
    InvalidOneCycleTotalSteps {
        total_steps: usize,
    },
    InvalidOneCyclePctStart {
        pct_start: f32,
    },
    InvalidOneCycleFinalDivFactor {
        final_div_factor: f32,
    },
    SchedulerStartLrExceedsBase {
        start_lr: f32,
        base_lr: f32,
    },
    SchedulerMaxLrBelowInitial {
        max_lr: f32,
        initial_lr: f32,
    },
    SchedulerMinLrExceedsBase {
        min_lr: f32,
        base_lr: f32,
    },
    InvalidDampening {
        dampening: f32,
    },
    InvalidWeightDecay {
        weight_decay: f32,
    },
    NesterovRequiresMomentum,
    ShapeMismatch {
        weights: Vec<usize>,
        grad: Vec<usize>,
    },
    MissingGradient {
        node: usize,
    },
    Tensor(TensorError),
    Autograd(AutogradError),
}

Errors returned by optimizer configuration and update steps.

Variants

InvalidLearningRate

Fields

lr: f32

InvalidMomentum

Fields

momentum: f32

InvalidBeta1

Fields

beta1: f32

InvalidBeta2

Fields

beta2: f32

InvalidEpsilon

Fields

epsilon: f32

InvalidRmsPropAlpha

Fields

alpha: f32

InvalidStepGamma

Fields

gamma: f32

InvalidStepSize

Fields

step_size: usize

InvalidCosineTMax

Fields

t_max: usize

InvalidWarmupSteps

Fields

warmup_steps: usize

InvalidOneCycleTotalSteps

Fields

total_steps: usize

InvalidOneCyclePctStart

Fields

pct_start: f32

InvalidOneCycleFinalDivFactor

Fields

final_div_factor: f32

SchedulerStartLrExceedsBase

Fields

start_lr: f32

base_lr: f32

SchedulerMaxLrBelowInitial

Fields

max_lr: f32

initial_lr: f32

SchedulerMinLrExceedsBase

Fields

min_lr: f32

base_lr: f32

InvalidDampening

Fields

dampening: f32

InvalidWeightDecay

Fields

weight_decay: f32

NesterovRequiresMomentum

ShapeMismatch

Fields

weights: Vec<usize>

grad: Vec<usize>

MissingGradient

Fields

node: usize

Tensor(TensorError)

Autograd(AutogradError)

Trait Implementations

impl Clone for OptimError

fn clone(&self) -> OptimError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptimError

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

Formats the value using the given formatter.

impl Display for OptimError

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

Formats the value using the given formatter.

impl Error for OptimError

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 From<AutogradError> for OptimError

fn from(source: AutogradError) -> Self

Converts to this type from the input type.

impl From<TensorError> for OptimError

fn from(source: TensorError) -> Self

Converts to this type from the input type.

impl PartialEq for OptimError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OptimError