C++ API Reference for Intel® Data Analytics Acceleration Library 2020 Update 1

List of all members
Parameter Struct Reference

Parameter base class for the Stochastic average gradient descent algorithm More...

Class Declaration

struct DAAL_EXPORT Parameter : public optimization_solver::iterative_solver::Parameter
{
const sum_of_functions::BatchPtr &function,
size_t nIterations = 100,
double accuracyThreshold = 1.0e-05,
const data_management::NumericTablePtr batchIndices = data_management::NumericTablePtr(),
const size_t batchSize = 128,
const data_management::NumericTablePtr learningRateSequence = data_management::NumericTablePtr(),
size_t seed = 777
);
virtual ~Parameter(){}
virtual services::Status check() const DAAL_C11_OVERRIDE;
data_management::NumericTablePtr batchIndices;
data_management::NumericTablePtr learningRateSequence;
size_t seed;
engines::EnginePtr engine;
};

Constructor & Destructor Documentation

Parameter ( const sum_of_functions::BatchPtr &  function,
size_t  nIterations = 100,
double  accuracyThreshold = 1.0e-05,
const data_management::NumericTablePtr  batchIndices = data_management::NumericTablePtr(),
const size_t  batchSize = 128,
const data_management::NumericTablePtr  learningRateSequence = data_management::NumericTablePtr(),
size_t  seed = 777 
)

Constructs the parameter base class of the Stochastic average gradient descent algorithm

Parameters
[in]functionObjective function represented as sum of functions
[in]nIterationsMaximal number of iterations of the algorithm
[in]accuracyThresholdAccuracy of the algorithm. The algorithm terminates when this accuracy is achieved
[in]batchIndicesNumeric table that represents 32 bit integer indices of terms in the objective function. If no indices are provided, the implementation will generate random indices.
[in]batchSizeNumber of batch indices to compute the stochastic gradient. If batchSize is equal to the number of terms in objective function then no random sampling is performed, and all terms are used to calculate the gradient. This parameter is ignored if batchIndices is provided.
[in]learningRateSequenceNumeric table that contains value of the learning rate
[in]seedSeed for random generation of 32 bit integer indices of terms in the objective function.
Deprecated:
This item will be removed in a future release. Use engine instead.

Member Function Documentation

virtual services::Status check ( ) const
virtual

Checks the correctness of the parameter

Returns
Status of computations

Member Data Documentation

data_management::NumericTablePtr batchIndices

Numeric table that represents 32 bit integer indices of terms in the objective function. If no indices are provided, the implementation will generate random indices.

engines::EnginePtr engine

Engine for random generation of 32 bit integer indices of terms in the objective function.

data_management::NumericTablePtr learningRateSequence

Numeric table that contains value of the learning rate

size_t seed

Seed for random generation of 32 bit integer indices of terms in the objective function.

Deprecated:
This item will be removed in a future release. Use engine instead.

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

For more complete information about compiler optimizations, see our Optimization Notice.