This project has retired. For details please refer to its Attic page.
mxnet: mxnet::cpp::AdamOptimizer Class Reference
Public Member Functions | List of all members
mxnet::cpp::AdamOptimizer Class Reference

#include <optimizer.h>

Inheritance diagram for mxnet::cpp::AdamOptimizer:
Inheritance graph
Collaboration diagram for mxnet::cpp::AdamOptimizer:
Collaboration graph

Public Member Functions

 AdamOptimizer (unsigned begin_num_update=0)
std::string GetType () const override
 get optimizer type More...
void Update (int index, NDArray weight, NDArray grad) override
 Update a weight with gradient. More...
- Public Member Functions inherited from mxnet::cpp::Optimizer
 Optimizer (unsigned begin_num_update)
 constructor More...
virtual ~Optimizer ()
 destructor More...
template<typename T >
OptimizerSetParam (const std::string &name, const T &value)
 set config parameters More...
OptimizerSetLRScheduler (std::unique_ptr< LRScheduler > lrScheduler)
std::string Serialize () const
 Serialize the optimizer parameters to a string. More...

Additional Inherited Members

- Protected Member Functions inherited from mxnet::cpp::Optimizer
const std::vector< const char * > GetParamKeys_ () const
const std::vector< const char * > GetParamValues_ () const
unsigned UpdateCount_ (int index)
float GetLR_ (int index)
float GetWD_ (int index)
- Static Protected Member Functions inherited from mxnet::cpp::Optimizer
static OpMap *& op_map ()
- Protected Attributes inherited from mxnet::cpp::Optimizer
std::map< std::string, std::string > params_
std::map< int, unsigned > count_
unsigned begin_num_update_
unsigned num_update_
std::unique_ptr< LRSchedulerlrScheduler_ = nullptr

Constructor & Destructor Documentation

mxnet::cpp::AdamOptimizer::AdamOptimizer ( unsigned  begin_num_update = 0)

Member Function Documentation

std::string mxnet::cpp::AdamOptimizer::GetType ( ) const

get optimizer type

string of optimizer type

Implements mxnet::cpp::Optimizer.

void mxnet::cpp::AdamOptimizer::Update ( int  index,
NDArray  weight,
NDArray  grad 

Update a weight with gradient.

indexthe unique index for the weight.
weightthe weight to update.
gradgradient for the weight.

Implements mxnet::cpp::Optimizer.

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