| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/> |
| <meta content="IE=9" http-equiv="X-UA-Compatible"/> |
| <meta content="Doxygen 1.8.11" name="generator"/> |
| <title>mxnet: cpp-package/include/mxnet-cpp/optimizer.h File Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script src="jquery.js" type="text/javascript"></script> |
| <script src="dynsections.js" type="text/javascript"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script src="search/searchdata.js" type="text/javascript"></script> |
| <script src="search/search.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { init_search(); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellpadding="0" cellspacing="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.11 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div class="tabs" id="navrow1"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div class="MSearchBoxInactive" id="MSearchBox"> |
| <span class="left"> |
| <img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/> |
| <input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/> |
| </span><span class="right"> |
| <a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="tabs2" id="navrow2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()"> |
| </div> |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)"> |
| </iframe> |
| </div> |
| <div class="navpath" id="nav-path"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_c9bbcf2f7c4ed40b1b23631ec8abffa6.html">cpp-package</a></li><li class="navelem"><a class="el" href="dir_eb07344824255b98f70969533c25e736.html">include</a></li><li class="navelem"><a class="el" href="dir_0327d24fd86e9ce22567ad8f859e5290.html">mxnet-cpp</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#namespaces">Namespaces</a> | |
| <a href="#define-members">Macros</a> | |
| <a href="#typedef-members">Typedefs</a> </div> |
| <div class="headertitle"> |
| <div class="title">optimizer.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <p>definition of optimizer |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include <map></code><br/> |
| <code>#include <vector></code><br/> |
| <code>#include <string></code><br/> |
| <code>#include <memory></code><br/> |
| <code>#include <functional></code><br/> |
| <code>#include "<a class="el" href="cpp-package_2include_2mxnet-cpp_2base_8h_source.html">mxnet-cpp/base.h</a>"</code><br/> |
| <code>#include "dmlc/logging.h"</code><br/> |
| <code>#include "<a class="el" href="cpp-package_2include_2mxnet-cpp_2ndarray_8h_source.html">mxnet-cpp/ndarray.h</a>"</code><br/> |
| <code>#include "<a class="el" href="op__map_8h_source.html">mxnet-cpp/op_map.h</a>"</code><br/> |
| <code>#include "<a class="el" href="lr__scheduler_8h_source.html">mxnet-cpp/lr_scheduler.h</a>"</code><br/> |
| </div><div class="textblock"><div class="dynheader"> |
| Include dependency graph for optimizer.h:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="" border="0" src="optimizer_8h__incl.png" usemap="#cpp-package_2include_2mxnet-cpp_2optimizer_8h"/></div> |
| <map id="cpp-package_2include_2mxnet-cpp_2optimizer_8h" name="cpp-package_2include_2mxnet-cpp_2optimizer_8h"> |
| <area alt="" coords="79,244,218,271" href="cpp-package_2include_2mxnet-cpp_2base_8h.html" id="node7" shape="rect" title="mxnet-cpp/base.h"/> |
| <area alt="" coords="462,95,617,121" href="cpp-package_2include_2mxnet-cpp_2ndarray_8h.html" id="node15" shape="rect" title="mxnet-cpp/ndarray.h"/> |
| <area alt="" coords="204,95,363,121" href="op__map_8h.html" id="node21" shape="rect" title="definition of OpMap "/> |
| <area alt="" coords="835,95,1017,121" href="lr__scheduler_8h.html" id="node22" shape="rect" title="Scheduling learning rate. "/> |
| <area alt="" coords="93,319,205,345" href="c__api_8h.html" id="node9" shape="rect" title="C API of mxnet. "/> |
| <area alt="" coords="349,169,495,196" href="shape_8h.html" id="node17" shape="rect" title="definition of shape "/> |
| </map> |
| </div> |
| </div> |
| <p><a href="optimizer_8h_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html">mxnet::cpp::Optimizer</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html" title="Optimizer interface. ">Optimizer</a> interface. <a href="classmxnet_1_1cpp_1_1Optimizer.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1OptimizerRegistry.html">mxnet::cpp::OptimizerRegistry</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1SGDOptimizer.html">mxnet::cpp::SGDOptimizer</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1RMSPropOptimizer.html">mxnet::cpp::RMSPropOptimizer</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1AdamOptimizer.html">mxnet::cpp::AdamOptimizer</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1AdaGradOptimizer.html">mxnet::cpp::AdaGradOptimizer</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1AdaDeltaOptimizer.html">mxnet::cpp::AdaDeltaOptimizer</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> |
| Namespaces</h2></td></tr> |
| <tr class="memitem:namespacemxnet"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html">mxnet</a></td></tr> |
| <tr class="memdesc:namespacemxnet"><td class="mdescLeft"> </td><td class="mdescRight">namespace of mxnet <br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:namespacemxnet_1_1cpp"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1cpp.html">mxnet::cpp</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
| Macros</h2></td></tr> |
| <tr class="memitem:af2d102c73cf9fe9bcc63a00e70083eaf"><td align="right" class="memItemLeft" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="optimizer_8h.html#af2d102c73cf9fe9bcc63a00e70083eaf">MXNETCPP_REGISTER_OPTIMIZER</a>(Name, OptimizerType)</td></tr> |
| <tr class="separator:af2d102c73cf9fe9bcc63a00e70083eaf"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> |
| Typedefs</h2></td></tr> |
| <tr class="memitem:a16a22578671e5ebcf8addb2275c317bc"><td align="right" class="memItemLeft" valign="top">typedef std::function< Optimizer *()> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1cpp.html#a16a22578671e5ebcf8addb2275c317bc">mxnet::cpp::OptimizerCreator</a></td></tr> |
| <tr class="separator:a16a22578671e5ebcf8addb2275c317bc"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>definition of optimizer </p> |
| <dl class="section author"><dt>Author</dt><dd>Chuntao Hong, Zhang Chen </dd></dl> |
| </div><h2 class="groupheader">Macro Definition Documentation</h2> |
| <a class="anchor" id="af2d102c73cf9fe9bcc63a00e70083eaf"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define MXNETCPP_REGISTER_OPTIMIZER</td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname">Name, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname">OptimizerType </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> <span class="keywordtype">int</span> __make_ ## OptimizerType ## _ ## Name ## __ = \</div><div class="line"> OptimizerRegistry::__REGISTER__(#Name, [](){<span class="keywordflow">return</span> <span class="keyword">new</span> OptimizerType();})</div></div><!-- fragment --> |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Sep 19 2019 13:11:20 for mxnet by <a href="http://www.doxygen.org/index.html"> |
| <img alt="doxygen" class="footer" src="doxygen.png"/> |
| </a> 1.8.11 |
| </small></address> |
| </body> |
| </html> |
