mlpack  git-master
ConstantStep Class Reference

Implementation of the ConstantStep stepsize decay policy for parallel SGD. More...

Public Member Functions

 ConstantStep (const double step=0.01)
 Member initialization constructor. More...

 
double StepSize (const size_t)
 This function is called in each iteration before the gradient update. More...

 

Detailed Description

Implementation of the ConstantStep stepsize decay policy for parallel SGD.

Definition at line 23 of file constant_step.hpp.

Constructor & Destructor Documentation

◆ ConstantStep()

ConstantStep ( const double  step = 0.01)
inline

Member initialization constructor.

The defaults here are not necessarily good for the given problem, so it is suggested that the values used be tailored to the task at hand.

Parameters
stepThe intial stepsize to use.

Definition at line 34 of file constant_step.hpp.

Member Function Documentation

◆ StepSize()

double StepSize ( const size_t  )
inline

This function is called in each iteration before the gradient update.

Parameters
numEpochThe iteration number for which the stepsize is to be calculated.
Returns
The step size for the current iteration.

Definition at line 43 of file constant_step.hpp.


The documentation for this class was generated from the following file: