Struct LionConfig 

pub struct LionConfig { /* private fields */ }

Configuration for the Lion optimizer.

Implementations

impl LionConfig

pub fn new() -> Self

Create a new instance of the config.

Arguments

Optional Arguments

grad_clipping

Gradient clipping configuration.

• Defaults to None

Default Arguments

beta_1

Interpolation factor used to compute the update direction.

• Defaults to 0.9

beta_2

Decay factor for the momentum state.

• Defaults to 0.99

weight_decay

Decoupled weight decay factor.

• Defaults to 0.0

impl LionConfig

pub fn with_beta_1(self, beta_1: f32) -> Self

Sets the value for the field beta_1.

Interpolation factor used to compute the update direction.

• Defaults to 0.9

pub fn with_beta_2(self, beta_2: f32) -> Self

Sets the value for the field beta_2.

Decay factor for the momentum state.

• Defaults to 0.99

pub fn with_weight_decay(self, weight_decay: f32) -> Self

Sets the value for the field weight_decay.

Decoupled weight decay factor.

• Defaults to 0.0

pub fn with_grad_clipping( self, grad_clipping: Option<GradientClippingConfig>, ) -> Self

Sets the value for the field grad_clipping.

Gradient clipping configuration.

• Defaults to None

impl LionConfig

pub fn build(&self) -> Lion

Build a Lion from the config.

The bare optimizer, which ModuleOptimizer::with_group takes to optimize one parameter group. init is the whole-module counterpart, and the only one that applies the configured gradient clipping.

pub fn init(&self) -> ModuleOptimizer

Initialize a Lion optimizer for a module.

Trait Implementations

impl Clone for LionConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for LionConfig

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

where P: AsRef<Path>,

Available on crate feature std only.

Saves the configuration to a file.

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

where P: AsRef<Path>,

Available on crate feature std only.

Loads the configuration from a file.

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

Loads the configuration from a binary buffer.

impl Debug for LionConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LionConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LionConfig

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

Formats the value using the given formatter.

impl Serialize for LionConfig

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

where S: Serializer,

Serialize this value into the given Serde serializer.