Struct LearningRateConfig

pub struct LearningRateConfig {
    pub count: u64,
    pub end: f64,
    pub start: f64,
}

A learning rate that can be a constant or exponentially decayed.

Fields

count: u64

The max count to update the learning rate.

end: f64

The final value of the learning rate.

start: f64

The initial value of the learning rate.

Implementations

impl LearningRateConfig

pub fn new(start: f64) -> Self

Create a new instance of the config.

impl LearningRateConfig

pub fn with_count(self, count: u64) -> Self

The max count to update the learning rate.

pub fn with_end(self, end: f64) -> Self

The final value of the learning rate.

impl LearningRateConfig

pub fn init(&self) -> LearningRate

Initialize the learning rate.

Trait Implementations

impl Clone for LearningRateConfig

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Config for LearningRateConfig

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 LearningRateConfig

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

Formats the value using the given formatter.

impl Default for LearningRateConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LearningRateConfig

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LearningRateConfig

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

Formats the value using the given formatter.

impl From<f64> for LearningRateConfig

fn from(start: f64) -> Self

Converts to this type from the input type.

impl PartialEq for LearningRateConfig

fn eq(&self, other: &LearningRateConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LearningRateConfig

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for LearningRateConfig

impl StructuralPartialEq for LearningRateConfig