Struct CosineAnnealingLr 

pub struct CosineAnnealingLr {
    pub max_lr: f64,
    pub min_lr: f64,
    pub total_steps: usize,
    pub warmup_steps: usize,
}

Cosine Annealing Learning Rate Scheduler with Linear Warmup.

This scheduler:

1. Linearly increases LR from 0 to max_lr during warmup phase
2. Applies cosine annealing from max_lr to min_lr after warmup

This is a common pattern in modern deep learning training.

Fields

max_lr: f64

The maximum learning rate (reached after warmup)

min_lr: f64

The minimum learning rate (reached at end of training)

total_steps: usize

The total number of training steps

warmup_steps: usize

The number of warmup steps

Implementations

impl CosineAnnealingLr

pub fn new(total_steps: usize) -> Self

Create a new instance of the config.

Arguments

Required Arguments

total_steps

The total number of training steps

Default Arguments

max_lr

The maximum learning rate (reached after warmup)

• Defaults to 1e-4

min_lr

The minimum learning rate (reached at end of training)

• Defaults to 1e-6

warmup_steps

The number of warmup steps

• Defaults to 0

impl CosineAnnealingLr

pub fn with_max_lr(self, max_lr: f64) -> Self

Sets the value for the field max_lr.

The maximum learning rate (reached after warmup)

• Defaults to 1e-4

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

Sets the value for the field min_lr.

The minimum learning rate (reached at end of training)

• Defaults to 1e-6

pub fn with_warmup_steps(self, warmup_steps: usize) -> Self

Sets the value for the field warmup_steps.

The number of warmup steps

• Defaults to 0

impl CosineAnnealingLr

pub fn get_lr(&self, step: usize) -> f64

Get the learning rate for the current training step.

Arguments

• step - Current training step (0-indexed)

Returns

• Learning rate for this step

Trait Implementations

impl Clone for CosineAnnealingLr

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 CosineAnnealingLr

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

Loads the configuration from a binary buffer.

impl Debug for CosineAnnealingLr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CosineAnnealingLr

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CosineAnnealingLr

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

Formats the value using the given formatter.

impl Serialize for CosineAnnealingLr

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

where S: Serializer,

Serialize this value into the given Serde serializer.