Struct burn::lr_scheduler::exponential::ExponentialLrSchedulerConfig

pub struct ExponentialLrSchedulerConfig { /* private fields */ }

The configuration for creating an exponential learning rate scheduler.

This scheduler returns the learning rate initial_lr at the first step, then multiplies it by a constant gamma at every iteration. At any iteration i (which starts from 0), the learning rate is given by initial_lr * gamma^i.

Implementations

impl ExponentialLrSchedulerConfig

pub fn new(initial_lr: f64, gamma: f64) -> ExponentialLrSchedulerConfig

Create a new instance of the config.

impl ExponentialLrSchedulerConfig

pub fn init(&self) -> ExponentialLrScheduler

Initializes a exponential learning rate scheduler.

Panics

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

Trait Implementations

impl Clone for ExponentialLrSchedulerConfig

fn clone(&self) -> ExponentialLrSchedulerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Config for ExponentialLrSchedulerConfig

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 ExponentialLrSchedulerConfig

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ExponentialLrSchedulerConfig

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

Formats the value using the given formatter.

impl Serialize for ExponentialLrSchedulerConfig

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.