Struct StepLrScheduler 

pub struct StepLrScheduler {
    pub initial_lr: f64,
    pub step_size: usize,
    pub gamma: f64,
    /* private fields */
}

Step-based learning rate scheduler. Decreases learning rate by a factor every step_size epochs.

Fields

initial_lr: f64

Initial learning rate.

step_size: usize

Step size (epochs).

gamma: f64

Multiplicative factor of learning rate decay.

Implementations

impl StepLrScheduler

pub fn new(initial_lr: f64, step_size: usize, gamma: f64) -> Self

Create a new step LR scheduler.

Trait Implementations

impl Clone for StepLrScheduler

fn clone(&self) -> StepLrScheduler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StepLrScheduler

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

Formats the value using the given formatter.

impl LrScheduler for StepLrScheduler

fn step(&mut self, optimizer: &mut dyn Optimizer)

Update learning rate based on current step/epoch.

fn get_lr(&self) -> f64

Get current learning rate.

fn state_dict(&self) -> HashMap<String, f64>

Get scheduler state as a dictionary.

fn load_state_dict(&mut self, state: &HashMap<String, f64>) -> TrainResult<()>

Load scheduler state from a dictionary.