Struct Sgd

pub struct Sgd {
    pub lr: f32,
    pub momentum: f32,
    pub weight_decay: f32,
    pub dampening: f32,
    pub nesterov: bool,
    pub state: State,
}

Stochastic gradient descent optimizer.

Fields

lr: f32

Learning rate

momentum: f32

Momentum strength. Default to Sgd::DEFAULT_MOMENTUM if not specified.

weight_decay: f32

Weight decay (L2 penalty). Default to Sgd::DEFAULT_WEIGHT_DECAY if not specified.

dampening: f32

Dampening for momentum. Default to Sgd::DEFAULT_DAMPENING if not specified.

nesterov: bool

Enables nesterov momentum. Default to Sgd::DEFAULT_NESTEROV if not specified.

state: State

Inner state

Implementations

impl Sgd

pub fn new(lr: impl Into<f32>) -> Self

Creates a new instance of Sgd.

impl Sgd

pub const DEFAULT_MOMENTUM: f32 = 0f32

Default momentum if not specified.

pub const DEFAULT_WEIGHT_DECAY: f32 = 0f32

Default weight decay if not specified.

pub const DEFAULT_DAMPENING: f32 = 0f32

Default dampening if not specified.

pub const DEFAULT_NESTEROV: bool = false

Default nesterov if not specified.

Trait Implementations

impl Buildable for Sgd

type Builder = SgdBuilder

The builder type for this buildable type

impl Builder<Sgd> for SgdBuilder

type Error = Infallible

Error with building

fn build(self) -> Result<Sgd, Self::Error>

Build the type

impl Clone for Sgd

fn clone(&self) -> Sgd

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sgd

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

Formats the value using the given formatter.

impl Optimizer for Sgd

fn update_single( &mut self, key: &Rc<str>, gradient: &Array, parameter: &mut Array, ) -> Result<()>

Apply SGD to a single parameter. Returns the updated parameter and the updated state.

type State = HashMap<Rc<str>, Array>

State of the optimizer.

fn state(&self) -> &Self::State

Get the state of the optimizer.

fn state_mut(&mut self) -> &mut Self::State

Get the mutable state of the optimizer.

fn update<M>( &mut self, model: &mut M, gradients: impl Borrow<FlattenedModuleParam>, ) -> Result<()>

where M: ModuleParameters,

Apply the gradients to the parameters of the model and update the model with the new parameters.

impl Updatable for &mut Sgd

fn updatable_states_len(&self) -> usize

Returns the number of updatable states.

fn updatable_states(&self) -> impl IntoIterator<Item = &Array>

Returns a list of references to the updatable states.

fn updatable_states_mut(&mut self) -> impl IntoIterator<Item = &mut Array>

Returns a list of mutable references to the updatable states.

impl Updatable for Sgd

fn updatable_states_len(&self) -> usize

Returns the number of updatable states.

fn updatable_states(&self) -> impl IntoIterator<Item = &Array>

Returns a list of references to the updatable states.

fn updatable_states_mut(&mut self) -> impl IntoIterator<Item = &mut Array>

Returns a list of mutable references to the updatable states.