Enum LrSchedule 

pub enum LrSchedule {
    Constant(f32),
    Step {
        base: f32,
        step_size: usize,
        gamma: f32,
    },
    Cosine {
        base: f32,
        min: f32,
        total: usize,
    },
    Warmup {
        base: f32,
        warmup: usize,
    },
    WarmupCosine {
        base: f32,
        min: f32,
        warmup: usize,
        total: usize,
    },
}

Common learning-rate schedules.

Variants

Constant(f32)

Fixed learning rate.

Step

Multiply base by gamma every step_size steps (staircase).

Fields

base: f32

step_size: usize

gamma: f32

Cosine

Cosine decay from base to min over total steps (then holds min).

Fields

base: f32

min: f32

total: usize

Warmup

Linear warmup from 0 to base over warmup steps, then holds base.

Fields

base: f32

warmup: usize

WarmupCosine

Linear warmup to base over warmup, then cosine decay to min by total — the standard transformer schedule.

Fields

base: f32

min: f32

warmup: usize

total: usize

Implementations

impl LrSchedule

pub fn lr_at(&self, step: usize) -> f32

Learning rate at step (0-based).

Trait Implementations

impl Clone for LrSchedule

fn clone(&self) -> LrSchedule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LrSchedule

impl Debug for LrSchedule

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

Formats the value using the given formatter.

impl PartialEq for LrSchedule

fn eq(&self, other: &LrSchedule) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LrSchedule