Struct CosineAnnealingLrSchedulerConfig 

pub struct CosineAnnealingLrSchedulerConfig { /* private fields */ }

The configuration for creating a Cosine Annealing learning rate scheduler.

This scheduler uses a cosine annealing schedule without warm restarts, where the learning rate follows a cosine curve from initial_lr down to min_lr over num_iters steps. After num_iters steps, the learning rate continues along the cosine curve without restarting.

This corresponds to PyTorch’s CosineAnnealingLR and is based on the closed-form schedule proposed in SGDR: Stochastic Gradient Descent with Warm Restarts.

Implementations

impl CosineAnnealingLrSchedulerConfig

pub fn new( initial_lr: f64, num_iters: usize, ) -> CosineAnnealingLrSchedulerConfig

Create a new instance of the config.

Arguments

Required Arguments

initial_lr

num_iters

Default Arguments

min_lr

• Defaults to 0.0

impl CosineAnnealingLrSchedulerConfig

pub fn with_min_lr(self, min_lr: f64) -> CosineAnnealingLrSchedulerConfig

Sets the value for the field min_lr.

• Defaults to 0.0

impl CosineAnnealingLrSchedulerConfig

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

Initializes a module 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]
• min_lr is out of range [0.0, initial_lr]
• num_iters is 0

Trait Implementations

impl Clone for CosineAnnealingLrSchedulerConfig

fn clone(&self) -> CosineAnnealingLrSchedulerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for CosineAnnealingLrSchedulerConfig

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 Debug for CosineAnnealingLrSchedulerConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CosineAnnealingLrSchedulerConfig

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CosineAnnealingLrSchedulerConfig

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

Formats the value using the given formatter.

impl From<CosineAnnealingLrSchedulerConfig> for LrSchedulerConfig

fn from(config: CosineAnnealingLrSchedulerConfig) -> LrSchedulerConfig

Converts to this type from the input type.

impl Serialize for CosineAnnealingLrSchedulerConfig

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.