Struct burn::lr_scheduler::cosine::CosineAnnealingLrSchedulerConfig

pub struct CosineAnnealingLrSchedulerConfig { /* private fields */ }

The configuration for creating a Cosine Annealing learning rate scheduler with warm restarts.

This scheduler returns the learning rate initial_lr at the first step, then changes it by following a cosine function. After num_iters iterations, the learning rate is reset to initial_lr.

Implementations

impl CosineAnnealingLrSchedulerConfig

pub fn new( initial_lr: f64, num_iters: usize, ) -> CosineAnnealingLrSchedulerConfig

Create a new instance of the config.

impl CosineAnnealingLrSchedulerConfig

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

Set the default value for the field.

impl CosineAnnealingLrSchedulerConfig

pub fn init(&self) -> CosineAnnealingLrScheduler

Initializes a Cosine learning rate scheduler.

Panics

This function panics if initial_lr and final_lr are not between 0 and 1.

Trait Implementations

impl Clone for CosineAnnealingLrSchedulerConfig

fn clone(&self) -> CosineAnnealingLrSchedulerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Config for CosineAnnealingLrSchedulerConfig

fn save<P>(&self, file: P) -> Result<(), Error>

where P: AsRef<Path>,

Saves the configuration to a file.

fn load<P>(file: P) -> Result<Self, ConfigError>

where P: AsRef<Path>,

Loads the configuration from a file.

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

Loads the configuration from a binary buffer.

impl<'de> Deserialize<'de> for CosineAnnealingLrSchedulerConfig

fn deserialize<D>( deserializer: D, ) -> Result<CosineAnnealingLrSchedulerConfig, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CosineAnnealingLrSchedulerConfig

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

Formats the value using the given formatter.

impl Serialize for CosineAnnealingLrSchedulerConfig

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

where S: Serializer,

Serialize this value into the given Serde serializer.