Struct StepLrSchedulerConfig

pub struct StepLrSchedulerConfig { /* private fields */ }

The configuration for create a step learning rate scheduler.

This scheduler returns the learning rate initial_lr from the start, and keeps doing so until the same value has been given for step_size times. Then it multiplies the learning rate by gamma before repeating the process.

Gamma values out of range (0.0, 1.0) and non-positive initial learning rates are acceptable, but a warning log will be output for such a value in case of mistyping.

Notes

The step method of the scheduler panics if it is called more than i32::MAX + 1 times.

Implementations

impl StepLrSchedulerConfig

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

Create a new instance of the config.

impl StepLrSchedulerConfig

pub fn with_gamma(self, gamma: f64) -> StepLrSchedulerConfig

The factor by which the learning rate is multiplied with each update. Default: 0.1.

impl StepLrSchedulerConfig

pub fn init(&self) -> Result<StepLrScheduler, String>

Initializes a step learning rate scheduler.

Errors

An error will be returned if step_size is 0.

Trait Implementations

impl Clone for StepLrSchedulerConfig

fn clone(&self) -> StepLrSchedulerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Config for StepLrSchedulerConfig

fn save<P>(&self, file: P) -> Result<(), Error>

where P: AsRef<Path>,

Saves the configuration to a file.

fn load<P>(file: P) -> Result<Self, ConfigError>

where P: AsRef<Path>,

Loads the configuration from a file.

fn load_binary(data: &[u8]) -> Result<Self, ConfigError>

Loads the configuration from a binary buffer.

impl<'de> Deserialize<'de> for StepLrSchedulerConfig

fn deserialize<D>( deserializer: D, ) -> Result<StepLrSchedulerConfig, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StepLrSchedulerConfig

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

Formats the value using the given formatter.

impl Serialize for StepLrSchedulerConfig

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.