Skip to main content

Optimizer

Enum Optimizer 

Source
pub enum Optimizer {
    Sgd(Sgd),
    AdaGrad(AdaGrad),
}
Expand description

Concrete optimizer enum wrapping all supported optimizers.

Variants§

§

Sgd(Sgd)

Stochastic gradient descent with optional L2 regularization.

§

AdaGrad(AdaGrad)

AdaGrad with per-parameter squared gradient accumulation.

Implementations§

Source§

impl Optimizer

Source

pub fn sgd(feature_count: usize, config: SgdConfig) -> Result<Self, RillError>

Create an SGD optimizer for feature_count features (plus intercept).

Source

pub fn adagrad( feature_count: usize, config: AdaGradConfig, ) -> Result<Self, RillError>

Create an AdaGrad optimizer for feature_count features (plus intercept).

Source

pub fn param_count(&self) -> usize

The number of parameters this optimizer manages (features + intercept).

Source

pub fn samples_seen(&self) -> u64

Number of samples the optimizer has processed.

Source

pub fn step( &mut self, weights: &mut [f64], intercept: &mut f64, grad_weights: &[f64], grad_intercept: f64, ) -> Result<(), RillError>

Apply a gradient step to weights (length feature_count) and intercept (single value). The gradient vector passed in must have the same length as weights; the intercept gradient is passed separately.

Source

pub fn reset(&mut self)

Reset the optimizer to its initial state.

Trait Implementations§

Source§

impl Clone for Optimizer

Source§

fn clone(&self) -> Optimizer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Optimizer

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V