mlpack  git-master
NoDecay Class Reference

Definition of the NoDecay class. More...

Public Member Functions

 NoDecay ()
 This constructor is called before the first iteration. More...

 
void Update (arma::mat &, double &, const arma::mat &)
 This function is called in each iteration after the policy update. More...

 
void Update (const arma::mat &, const arma::mat &, const arma::mat &, const arma::mat &, const size_t, double &)
 This function is called in each iteration after the SVRG update step. More...

 

Detailed Description

Definition of the NoDecay class.

Use this as a template for your own.

Definition at line 24 of file no_decay.hpp.

Constructor & Destructor Documentation

◆ NoDecay()

NoDecay ( )
inline

This constructor is called before the first iteration.

Definition at line 30 of file no_decay.hpp.

Member Function Documentation

◆ Update() [1/2]

void Update ( arma::mat &  ,
double &  ,
const arma::mat &   
)
inline

This function is called in each iteration after the policy update.

Parameters
iterateParameters that minimize the function.
stepSizeStep size to be used for the given iteration.
gradientThe gradient matrix.

Definition at line 39 of file no_decay.hpp.

◆ Update() [2/2]

void Update ( const arma::mat &  ,
const arma::mat &  ,
const arma::mat &  ,
const arma::mat &  ,
const size_t  ,
double &   
)
inline

This function is called in each iteration after the SVRG update step.

Parameters
iterateParameters that minimize the function.
iterate0The last function parameters at time t - 1.
gradientThe current gradient matrix at time t.
fullGradientThe computed full gradient.
stepSizeStep size to be used for the given iteration.

Definition at line 55 of file no_decay.hpp.


The documentation for this class was generated from the following file:
  • src/mlpack/core/optimizers/sgd/decay_policies/no_decay.hpp