Struct LinearLrSchedulerConfig

pub struct LinearLrSchedulerConfig { /* private fields */ }

Available on crate feature std only.

The configuration for creating a linear learning rate scheduler.

This scheduler returns the learning rate initial_lr at the first step, then changes it by a constant amount on each iteration until reaching a final learning rate final_lr. The num_iters parameter controls how many iterations are needed to go from initial_lr to final_lr.

Implementations

impl LinearLrSchedulerConfig

pub fn new( initial_lr: LearningRate, final_lr: LearningRate, num_iters: usize, ) -> Self

Create a new instance of the config.

impl LinearLrSchedulerConfig

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

Initializes a linear learning rate scheduler.

Errors

An error will be returned if any of the following conditions is true:

• initial_lr is out of range (0.0, 1.0]
• final_lr is out of range [0.0, 1.0]
• num_iters is 0

Trait Implementations

impl Clone for LinearLrSchedulerConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for LinearLrSchedulerConfig

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

Saves the configuration to a file.

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

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 LinearLrSchedulerConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LinearLrSchedulerConfig

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

Formats the value using the given formatter.

impl Serialize for LinearLrSchedulerConfig

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

where S: Serializer,

Serialize this value into the given Serde serializer.