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

List of all members
BaseParameter Struct Reference

BaseParameter base class for the Stochastic gradient descent algorithm More...

Class Declaration

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

Constructor & Destructor Documentation

BaseParameter ( const sum_of_functions::BatchPtr &  function,
size_t  nIterations = 100,
double  accuracyThreshold = 1.0e-05,
data_management::NumericTablePtr  batchIndices = data_management::NumericTablePtr(),
data_management::NumericTablePtr  learningRateSequence = data_management::NumericTablePtr(new data_management::HomogenNumericTable< double >(1, 1, data_management::NumericTableIface::doAllocate, 1.0)),
size_t  batchSize = 1,
size_t  seed = 777 
)

Constructs the parameter base class of the Stochastic 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]learningRateSequenceNumeric table that contains values of the learning rate sequence
[in]batchSizeBatch size
[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

Reimplemented in Parameter< momentum >, Parameter< miniBatch >, and Parameter< defaultDense >.

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 values of the learning rate sequence

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.