Trait candle_nn::optim::Optimizer

source · 
pub trait Optimizer: Sized {
    type Config: Sized;

    // Required methods
    fn new(vars: Vec<Var>, config: Self::Config) -> Result<Self>;
    fn step(&mut self, grads: &GradStore) -> Result<()>;
    fn learning_rate(&self) -> f64;
    fn set_learning_rate(&mut self, lr: f64);

    // Provided methods
    fn empty(config: Self::Config) -> Result<Self> { ... }
    fn backward_step(&mut self, loss: &Tensor) -> Result<()> { ... }
    fn from_slice(vars: &[&Var], config: Self::Config) -> Result<Self> { ... }
}
Expand description

The interface optimizers should implement.

Required Associated Types§

source

type Config: Sized

Required Methods§

source

fn new(vars: Vec<Var>, config: Self::Config) -> Result<Self>

source

fn step(&mut self, grads: &GradStore) -> Result<()>

source

fn learning_rate(&self) -> f64

source

fn set_learning_rate(&mut self, lr: f64)

Provided Methods§

source

fn empty(config: Self::Config) -> Result<Self>

source

fn backward_step(&mut self, loss: &Tensor) -> Result<()>

source

fn from_slice(vars: &[&Var], config: Self::Config) -> Result<Self>

Object Safety§

This trait is not object safe.

Implementors§