Optimizer

Trait Optimizer 

Source
pub trait Optimizer {
    // Required methods
    fn step(&mut self);
    fn zero_grad(&mut self);
    fn get_lr(&self) -> f32;
    fn set_lr(&mut self, lr: f32);
    fn parameters(&self) -> &[Parameter];

    // Provided method
    fn num_parameters(&self) -> usize { ... }
}
Expand description

Trait for all optimizers.

Optimizers update model parameters based on gradients.

Required Methods§

Source

fn step(&mut self)

Performs a single optimization step.

Updates all parameters based on their gradients.

Source

fn zero_grad(&mut self)

Zeros all parameter gradients.

Source

fn get_lr(&self) -> f32

Returns the current learning rate.

Source

fn set_lr(&mut self, lr: f32)

Sets the learning rate.

Source

fn parameters(&self) -> &[Parameter]

Returns the parameters being optimized.

Provided Methods§

Source

fn num_parameters(&self) -> usize

Returns the number of parameters.

Implementors§