Struct OnlineYogiParameters

pub struct OnlineYogiParameters {
    pub l1: f32,
    pub l2: f32,
    pub beta2: f32,
    pub initial_v: f32,
    pub initial_linear: f32,
    pub activation: Option<Activation>,
}

The online Yogi optimizer does not implement hyper-parameter update; use the dynamic learning rate feature instead, setting the learning rate to: user learning_rate * sqrt(1 - beta2^t) / (1 - beta1^t) Here, t is the current timestep.

https://papers.nips.cc/paper/8186-adaptive-methods-for-nonconvex-optimization.pdf plus some extensions based on FTRL.

Note that the code by default implements the lazy version of online Yogi.

Fields

l1: f32

The L1 regularization parameter (used analogously to the one in FTRL).

l2: f32

The L2 regularization parameter (used analogously to the one in FTRL).

beta2: f32

\beta_2 from Algorithm 2 in the paper.

initial_v: f32

Initial value of V variable in paper.

initial_linear: f32

Initial value of linear variable in FTRL.

activation: Option<Activation>

Activation to use to replace sign function in v_t update in Algorithm 2 of paper.

Trait Implementations

impl Clone for OnlineYogiParameters

fn clone(&self) -> OnlineYogiParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OnlineYogiParameters

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

Formats the value using the given formatter.

impl Default for OnlineYogiParameters

fn default() -> Self

Returns the “default value” for a type.

impl Message for OnlineYogiParameters

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for OnlineYogiParameters

fn eq(&self, other: &OnlineYogiParameters) -> 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 StructuralPartialEq for OnlineYogiParameters