Struct NoamLrSchedulerConfig 

pub struct NoamLrSchedulerConfig { /* private fields */ }

Configuration to create a noam learning rate scheduler.

Implementations

impl NoamLrSchedulerConfig

pub fn new(factor: f64) -> NoamLrSchedulerConfig

Create a new instance of the config.

Arguments

Required Arguments

factor

The overall scale factor for the learning rate decay.

Default Arguments

warmup_steps

The number of steps before the exponential decay stats.

• Defaults to 4000

model_size

The size of the model.

• Defaults to 512

impl NoamLrSchedulerConfig

pub fn with_warmup_steps(self, warmup_steps: usize) -> NoamLrSchedulerConfig

Sets the value for the field warmup_steps.

The number of steps before the exponential decay stats.

• Defaults to 4000

pub fn with_model_size(self, model_size: usize) -> NoamLrSchedulerConfig

Sets the value for the field model_size.

The size of the model.

• Defaults to 512

impl NoamLrSchedulerConfig

pub fn init(&self) -> Result<ModuleLrScheduler, String>

Initializes a module learning rate scheduler.

Errors

An error will be returned if any of the following conditions is true:

• warmup_steps is 0
• model_size is 0

Trait Implementations

impl Clone for NoamLrSchedulerConfig

fn clone(&self) -> NoamLrSchedulerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for NoamLrSchedulerConfig

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 Debug for NoamLrSchedulerConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NoamLrSchedulerConfig

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NoamLrSchedulerConfig

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

Formats the value using the given formatter.

impl From<NoamLrSchedulerConfig> for LrSchedulerConfig

fn from(config: NoamLrSchedulerConfig) -> LrSchedulerConfig

Converts to this type from the input type.

impl Serialize for NoamLrSchedulerConfig

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.