Struct rusty_machine::learning::optim::grad_desc::StochasticGD

pub struct StochasticGD { /* fields omitted */ }

Stochastic Gradient Descent algorithm.

Uses basic momentum to control the learning rate.

Methods

impl StochasticGD

fn new(alpha: f64, mu: f64, iters: usize) -> StochasticGD

Construct a stochastic gradient descent algorithm.

Requires the learning rate, momentum rate and iteration count to be specified.

Examples

use rusty_machine::learning::optim::grad_desc::StochasticGD;

let sgd = StochasticGD::new(0.1, 0.3, 5);

Trait Implementations

impl Clone for StochasticGD

fn clone(&self) -> StochasticGD

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for StochasticGD

impl Debug for StochasticGD

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for StochasticGD

The default Stochastic GD algorithm.

The defaults are:

• alpha = 0.1
• mu = 0.1
• iters = 20

fn default() -> StochasticGD

Returns the "default value" for a type.

impl<M> OptimAlgorithm<M> for StochasticGD where M: Optimizable<Inputs=Matrix<f64>, Targets=Matrix<f64>>

fn optimize(&self,
            model: &M,
            start: &[f64],
            inputs: &M::Inputs,
            targets: &M::Targets)
            -> Vec<f64>

Return the optimized parameter using gradient optimization.