Struct burn_core::optim::adaptor::OptimizerAdaptor

pub struct OptimizerAdaptor<O, M, B>where
    O: SimpleOptimizer<B::InnerBackend>,
    M: AutodiffModule<B>,
    B: AutodiffBackend,{ /* private fields */ }

Wrapper struct that adapts any simple optimizer into an optimizer.

Implementations

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

pub fn with_grad_clipping(self, gradient_clipping: GradientClipping) -> Self

Sets the gradient clipping.

Arguments

• gradient_clipping - The gradient clipping.

Returns

The optimizer.

Trait Implementations

impl<O, B, M> From<O> for OptimizerAdaptor<O, M, B>where B: AutodiffBackend, M: AutodiffModule<B>, O: SimpleOptimizer<B::InnerBackend>,

fn from(optim: O) -> Self

Converts to this type from the input type.

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 as AutodiffBackend>::InnerBackend>>

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

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.