Struct burn::lr_scheduler::cosine::CosineAnnealingLrScheduler

pub struct CosineAnnealingLrScheduler { /* private fields */ }

A Cosine Annealing learning rate scheduler.

This scheduler is described in SGDR: Stochastic Gradient Descent with Warm Restarts. See CosineAnnealingLrSchedulerConfig for more information.

Trait Implementations

impl Clone for CosineAnnealingLrScheduler

fn clone(&self) -> CosineAnnealingLrScheduler

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CosineAnnealingLrScheduler

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

Formats the value using the given formatter.

impl LrScheduler for CosineAnnealingLrScheduler

type Record<B: Backend> = usize

Scheduler associative type to be used when saving and loading the state.

fn step(&mut self) -> f64

Perform the scheduler step, potentially updating its state, and returning the effective learning rate.

fn to_record<B>(&self) -> <CosineAnnealingLrScheduler as LrScheduler>::Record<B>

where B: Backend,

Get the current state of the scheduler as a record.

fn load_record<B>( self, record: <CosineAnnealingLrScheduler as LrScheduler>::Record<B>, ) -> CosineAnnealingLrScheduler

where B: Backend,

Load the state of the scheduler as a record.

impl Copy for CosineAnnealingLrScheduler