Trait Optimizer

pub trait Optimizer<M, B>: Send
where
    M: AutodiffModule<B>,
    B: AutodiffBackend,
{
    type Record: Record<B>;

    // Required methods
    fn step(&mut self, lr: LearningRate, module: M, grads: GradientsParams) -> M;
    fn to_record(&self) -> Self::Record;
    fn load_record(self, record: Self::Record) -> Self;
}

General trait to optimize module.

Required Associated Types

type Record: Record<B>

Optimizer associative type to be used when saving and loading the state.

Required Methods

fn step(&mut self, lr: LearningRate, module: M, grads: GradientsParams) -> M

Perform the optimizer step using the given learning rate and gradients. The updated module is returned.

fn to_record(&self) -> Self::Record

Get the current state of the optimizer as a record.

fn load_record(self, record: Self::Record) -> Self

Load the state of the optimizer as a record.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<O, B, M> Optimizer<M, B> for OptimizerAdaptor<O, M, B>

where B: AutodiffBackend, M: AutodiffModule<B>, O: SimpleOptimizer<B::InnerBackend>,

type Record = HashMap<ParamId, AdaptorRecord<O, B>>