| <!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: mxnet::cpp::Executor Class 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 class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><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="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class 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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1cpp.html">cpp</a></li><li class="navelem"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html">Executor</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classmxnet_1_1cpp_1_1Executor-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::cpp::Executor Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <p><a class="el" href="classmxnet_1_1cpp_1_1Executor.html" title="Executor interface. ">Executor</a> interface. |
| <a href="classmxnet_1_1cpp_1_1Executor.html#details">More...</a></p> |
| <p><code>#include <<a class="el" href="cpp-package_2include_2mxnet-cpp_2executor_8h_source.html">executor.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::cpp::Executor:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="Collaboration graph" border="0" src="classmxnet_1_1cpp_1_1Executor__coll__graph.png" usemap="#mxnet_1_1cpp_1_1Executor_coll__map"/></div> |
| <map id="mxnet_1_1cpp_1_1Executor_coll__map" name="mxnet_1_1cpp_1_1Executor_coll__map"> |
| </map> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a86cd99024edf91d7554f28c5e128dc7e"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#a86cd99024edf91d7554f28c5e128dc7e">Executor</a> (const <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> &symbol, <a class="el" href="classmxnet_1_1cpp_1_1Context.html">Context</a> context, const std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > &<a class="el" href="classmxnet_1_1cpp_1_1Executor.html#a13d04b04cfafce126946be071549ace9">arg_arrays</a>, const std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > &<a class="el" href="classmxnet_1_1cpp_1_1Executor.html#a42694f583467b2b517ea8f8c0250655b">grad_arrays</a>, const std::vector< <a class="el" href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845">OpReqType</a> > &grad_reqs, const std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > &<a class="el" href="classmxnet_1_1cpp_1_1Executor.html#a11cc4c29bb7d5f859e9bbb4bc0df51ab">aux_arrays</a>, const std::map< std::string, <a class="el" href="classmxnet_1_1cpp_1_1Context.html">Context</a> > &group_to_ctx=std::map< std::string, <a class="el" href="classmxnet_1_1cpp_1_1Context.html">Context</a> >(), <a class="el" href="classmxnet_1_1cpp_1_1Executor.html">Executor</a> *shared_exec=nullptr)</td></tr> |
| <tr class="separator:a86cd99024edf91d7554f28c5e128dc7e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aefeb9bc416efd9aa6547e746d54724c1"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#aefeb9bc416efd9aa6547e746d54724c1">Executor</a> (const <a class="el" href="c__api_8h.html#a6f224ee35892507405ced8429d874726">ExecutorHandle</a> &h)</td></tr> |
| <tr class="separator:aefeb9bc416efd9aa6547e746d54724c1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1fef41367238aaf8315fe5715a9f8f47"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#a1fef41367238aaf8315fe5715a9f8f47">Forward</a> (bool is_train)</td></tr> |
| <tr class="memdesc:a1fef41367238aaf8315fe5715a9f8f47"><td class="mdescLeft"> </td><td class="mdescRight">Perform a Forward operation of <a class="el" href="classmxnet_1_1cpp_1_1Operator.html" title="Operator interface. ">Operator</a> After this operation, user can get the result by using function head. <a href="#a1fef41367238aaf8315fe5715a9f8f47">More...</a><br/></td></tr> |
| <tr class="separator:a1fef41367238aaf8315fe5715a9f8f47"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abd98fc4f87cd8adea049a31a840898e4"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#abd98fc4f87cd8adea049a31a840898e4">Backward</a> (const std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > &head_grads=std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> >())</td></tr> |
| <tr class="memdesc:abd98fc4f87cd8adea049a31a840898e4"><td class="mdescLeft"> </td><td class="mdescRight">Perform a Backward operation of the <a class="el" href="classmxnet_1_1cpp_1_1Operator.html" title="Operator interface. ">Operator</a>. This must be called after Forward. After this operation, NDArrays specified by grad_in_args_store will be updated accordingly. User is allowed to pass in an empty Array if the head node is loss function and head gradeitn is not needed. <a href="#abd98fc4f87cd8adea049a31a840898e4">More...</a><br/></td></tr> |
| <tr class="separator:abd98fc4f87cd8adea049a31a840898e4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa4e594bc8b840f03c148aa84c472cb99"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#aa4e594bc8b840f03c148aa84c472cb99">Reshape</a> ()</td></tr> |
| <tr class="separator:aa4e594bc8b840f03c148aa84c472cb99"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa9ffb2228d9a552a43277704dcf2ad64"><td align="right" class="memItemLeft" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#aa9ffb2228d9a552a43277704dcf2ad64">DebugStr</a> ()</td></tr> |
| <tr class="memdesc:aa9ffb2228d9a552a43277704dcf2ad64"><td class="mdescLeft"> </td><td class="mdescRight">update the arguments with given learning rate and optimizer <a href="#aa9ffb2228d9a552a43277704dcf2ad64">More...</a><br/></td></tr> |
| <tr class="separator:aa9ffb2228d9a552a43277704dcf2ad64"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad6a26ffaabff769ee829221ef47e29e6"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#ad6a26ffaabff769ee829221ef47e29e6">~Executor</a> ()</td></tr> |
| <tr class="memdesc:ad6a26ffaabff769ee829221ef47e29e6"><td class="mdescLeft"> </td><td class="mdescRight">destructor, free the handle <a href="#ad6a26ffaabff769ee829221ef47e29e6">More...</a><br/></td></tr> |
| <tr class="separator:ad6a26ffaabff769ee829221ef47e29e6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a942ef73436ecb2bcfde588e004037963"><td align="right" class="memItemLeft" valign="top">std::map< std::string, <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#a942ef73436ecb2bcfde588e004037963">arg_dict</a> ()</td></tr> |
| <tr class="separator:a942ef73436ecb2bcfde588e004037963"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ca4e8a5517ac2a35824adda6c80f872"><td align="right" class="memItemLeft" valign="top">std::map< std::string, <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#a4ca4e8a5517ac2a35824adda6c80f872">grad_dict</a> ()</td></tr> |
| <tr class="separator:a4ca4e8a5517ac2a35824adda6c80f872"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6c6ef2d2f79c26fd0bad949243f7a37a"><td align="right" class="memItemLeft" valign="top">std::map< std::string, <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#a6c6ef2d2f79c26fd0bad949243f7a37a">aux_dict</a> ()</td></tr> |
| <tr class="separator:a6c6ef2d2f79c26fd0bad949243f7a37a"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:a13d04b04cfafce126946be071549ace9"><td align="right" class="memItemLeft" valign="top">std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#a13d04b04cfafce126946be071549ace9">arg_arrays</a></td></tr> |
| <tr class="separator:a13d04b04cfafce126946be071549ace9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a42694f583467b2b517ea8f8c0250655b"><td align="right" class="memItemLeft" valign="top">std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#a42694f583467b2b517ea8f8c0250655b">grad_arrays</a></td></tr> |
| <tr class="separator:a42694f583467b2b517ea8f8c0250655b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a11cc4c29bb7d5f859e9bbb4bc0df51ab"><td align="right" class="memItemLeft" valign="top">std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#a11cc4c29bb7d5f859e9bbb4bc0df51ab">aux_arrays</a></td></tr> |
| <tr class="separator:a11cc4c29bb7d5f859e9bbb4bc0df51ab"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac8da23a16e33e0e75a44f803cd3b7933"><td align="right" class="memItemLeft" valign="top">std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#ac8da23a16e33e0e75a44f803cd3b7933">outputs</a></td></tr> |
| <tr class="memdesc:ac8da23a16e33e0e75a44f803cd3b7933"><td class="mdescLeft"> </td><td class="mdescRight">arrays store the outputs of forward <a href="#ac8da23a16e33e0e75a44f803cd3b7933">More...</a><br/></td></tr> |
| <tr class="separator:ac8da23a16e33e0e75a44f803cd3b7933"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:a1aceee49824f6ba6ea0d4b26a8ebe1d4"><td align="right" class="memItemLeft" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html#a1aceee49824f6ba6ea0d4b26a8ebe1d4">Monitor</a></td></tr> |
| <tr class="separator:a1aceee49824f6ba6ea0d4b26a8ebe1d4"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="classmxnet_1_1cpp_1_1Executor.html" title="Executor interface. ">Executor</a> interface. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a86cd99024edf91d7554f28c5e128dc7e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::cpp::Executor::Executor </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> & </td> |
| <td class="paramname"><em>symbol</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1Context.html">Context</a> </td> |
| <td class="paramname"><em>context</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > & </td> |
| <td class="paramname"><em>arg_arrays</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > & </td> |
| <td class="paramname"><em>grad_arrays</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845">OpReqType</a> > & </td> |
| <td class="paramname"><em>grad_reqs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > & </td> |
| <td class="paramname"><em>aux_arrays</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::map< std::string, <a class="el" href="classmxnet_1_1cpp_1_1Context.html">Context</a> > & </td> |
| <td class="paramname"><em>group_to_ctx</em> = <code>std::map< std::string, <a class="el" href="classmxnet_1_1cpp_1_1Context.html">Context</a> >()</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1Executor.html">Executor</a> * </td> |
| <td class="paramname"><em>shared_exec</em> = <code>nullptr</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="aefeb9bc416efd9aa6547e746d54724c1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::cpp::Executor::Executor </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="c__api_8h.html#a6f224ee35892507405ced8429d874726">ExecutorHandle</a> & </td> |
| <td class="paramname"><em>h</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="ad6a26ffaabff769ee829221ef47e29e6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::cpp::Executor::~Executor </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>destructor, free the handle </p> |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a942ef73436ecb2bcfde588e004037963"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::map<std::string, <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>> mxnet::cpp::Executor::arg_dict </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="a6c6ef2d2f79c26fd0bad949243f7a37a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::map<std::string, <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>> mxnet::cpp::Executor::aux_dict </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="abd98fc4f87cd8adea049a31a840898e4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mxnet::cpp::Executor::Backward </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> > & </td> |
| <td class="paramname"><em>head_grads</em> = <code>std::vector<<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>>()</code></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Perform a Backward operation of the <a class="el" href="classmxnet_1_1cpp_1_1Operator.html" title="Operator interface. ">Operator</a>. This must be called after Forward. After this operation, NDArrays specified by grad_in_args_store will be updated accordingly. User is allowed to pass in an empty Array if the head node is loss function and head gradeitn is not needed. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">head_grads</td><td>the gradient of head nodes to be backproped. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <a class="anchor" id="aa9ffb2228d9a552a43277704dcf2ad64"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string mxnet::cpp::Executor::DebugStr </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>update the arguments with given learning rate and optimizer </p> |
| <dl class="section return"><dt>Returns</dt><dd>the SymbolHandle </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a1fef41367238aaf8315fe5715a9f8f47"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mxnet::cpp::Executor::Forward </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>is_train</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Perform a Forward operation of <a class="el" href="classmxnet_1_1cpp_1_1Operator.html" title="Operator interface. ">Operator</a> After this operation, user can get the result by using function head. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a4ca4e8a5517ac2a35824adda6c80f872"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::map<std::string, <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>> mxnet::cpp::Executor::grad_dict </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="aa4e594bc8b840f03c148aa84c472cb99"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mxnet::cpp::Executor::Reshape </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <h2 class="groupheader">Friends And Related Function Documentation</h2> |
| <a class="anchor" id="a1aceee49824f6ba6ea0d4b26a8ebe1d4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">friend class <a class="el" href="classmxnet_1_1cpp_1_1Monitor.html">Monitor</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="a13d04b04cfafce126946be071549ace9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>> mxnet::cpp::Executor::arg_arrays</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="a11cc4c29bb7d5f859e9bbb4bc0df51ab"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>> mxnet::cpp::Executor::aux_arrays</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="a42694f583467b2b517ea8f8c0250655b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>> mxnet::cpp::Executor::grad_arrays</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="ac8da23a16e33e0e75a44f803cd3b7933"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>> mxnet::cpp::Executor::outputs</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>arrays store the outputs of forward </p> |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>cpp-package/include/mxnet-cpp/<a class="el" href="cpp-package_2include_2mxnet-cpp_2executor_8h_source.html">executor.h</a></li> |
| </ul> |
| </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> |
