Struct SchedulerConfig 

pub struct SchedulerConfig {
    pub scheduler_type: SchedulerType,
    pub base_lr: f64,
    pub max_lr: Option<f64>,
    pub min_lr: Option<f64>,
    pub total_steps: Option<usize>,
    pub step_size: Option<usize>,
    pub gamma: Option<f64>,
    pub warmup_steps: Option<usize>,
    pub pct_start: Option<f64>,
}

Builder for creating scheduler configurations.

Fields

scheduler_type: SchedulerType

The type of scheduler to construct.

base_lr: f64

Base learning rate.

max_lr: Option<f64>

Optional maximum learning rate (used by cyclical and one-cycle schedulers).

min_lr: Option<f64>

Optional minimum learning rate floor.

total_steps: Option<usize>

Optional total number of training steps.

step_size: Option<usize>

Optional step size for decay / cyclical half-period.

gamma: Option<f64>

Optional decay factor (used by step decay).

warmup_steps: Option<usize>

Optional number of warmup steps.

pct_start: Option<f64>

Optional fraction of total steps used for warmup in one-cycle.

Implementations

impl SchedulerConfig

pub fn step_decay(base_lr: f64, gamma: f64, step_size: usize) -> Self

Create a step-decay scheduler configuration.

pub fn cosine(base_lr: f64, min_lr: f64, t_max: usize) -> Self

Create a cosine annealing scheduler configuration.

pub fn one_cycle(base_lr: f64, max_lr: f64, total_steps: usize) -> Self

Create a one-cycle scheduler configuration.

Trait Implementations

impl Clone for SchedulerConfig

fn clone(&self) -> SchedulerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchedulerConfig

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

Formats the value using the given formatter.