Struct OneCycleLR 

pub struct OneCycleLR { /* private fields */ }

One-cycle learning rate scheduler.

Implements the 1cycle policy from “Super-Convergence” paper.

Implementations

impl OneCycleLR

pub fn new<O: Optimizer>(optimizer: &O, max_lr: f32, total_steps: usize) -> Self

Creates a new OneCycleLR scheduler.

pub fn with_options<O: Optimizer>( _optimizer: &O, max_lr: f32, total_steps: usize, pct_start: f32, div_factor: f32, final_div_factor: f32, ) -> Self

Creates OneCycleLR with options.

Trait Implementations

impl LRScheduler for OneCycleLR

fn step<O: Optimizer>(&mut self, optimizer: &mut O)

Updates the learning rate.

fn get_last_lr(&self) -> f32

Returns the current learning rate.

fn get_step(&self) -> usize

Returns the current epoch/step count.