| <!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::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="classmxnet_1_1Executor.html">Executor</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classmxnet_1_1Executor-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::Executor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <p><a class="el" href="classmxnet_1_1Executor.html" title="Executor of a computation graph. Executor can be created by Binding a symbol. ">Executor</a> of a computation graph. <a class="el" href="classmxnet_1_1Executor.html" title="Executor of a computation graph. Executor can be created by Binding a symbol. ">Executor</a> can be created by Binding a symbol. |
| <a href="classmxnet_1_1Executor.html#details">More...</a></p> |
| <p><code>#include <<a class="el" href="include_2mxnet_2executor_8h_source.html">executor.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::Executor:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="Collaboration graph" border="0" src="classmxnet_1_1Executor__coll__graph.png" usemap="#mxnet_1_1Executor_coll__map"/></div> |
| <map id="mxnet_1_1Executor_coll__map" name="mxnet_1_1Executor_coll__map"> |
| </map> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:a5684c74daafc9b80681cde6a9b7b4587"><td align="right" class="memItemLeft" valign="top">typedef std::function< void(const char *, void *)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#a5684c74daafc9b80681cde6a9b7b4587">MonitorCallback</a></td></tr> |
| <tr class="memdesc:a5684c74daafc9b80681cde6a9b7b4587"><td class="mdescLeft"> </td><td class="mdescRight">the prototype of user-defined monitor callback <a href="#a5684c74daafc9b80681cde6a9b7b4587">More...</a><br/></td></tr> |
| <tr class="separator:a5684c74daafc9b80681cde6a9b7b4587"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:adf445ff665c954061889d6bbee3c1c2a"><td align="right" class="memItemLeft" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#adf445ff665c954061889d6bbee3c1c2a">~Executor</a> ()</td></tr> |
| <tr class="memdesc:adf445ff665c954061889d6bbee3c1c2a"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#adf445ff665c954061889d6bbee3c1c2a">More...</a><br/></td></tr> |
| <tr class="separator:adf445ff665c954061889d6bbee3c1c2a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab3716be8e6c265b091e618f46eeb6f9b"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#ab3716be8e6c265b091e618f46eeb6f9b">Forward</a> (bool is_train)=0</td></tr> |
| <tr class="memdesc:ab3716be8e6c265b091e618f46eeb6f9b"><td class="mdescLeft"> </td><td class="mdescRight">Perform a Forward operation of <a class="el" href="classmxnet_1_1Operator.html" title="Operator interface. Operator defines basic operation unit of optimized computation graph in mxnet...">Operator</a> After this operation, user can get the result by using function head. <a href="#ab3716be8e6c265b091e618f46eeb6f9b">More...</a><br/></td></tr> |
| <tr class="separator:ab3716be8e6c265b091e618f46eeb6f9b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3e261d44065848e434c527000d4390c8"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#a3e261d44065848e434c527000d4390c8">PartialForward</a> (bool is_train, int step, int *step_left)=0</td></tr> |
| <tr class="memdesc:a3e261d44065848e434c527000d4390c8"><td class="mdescLeft"> </td><td class="mdescRight">Perform a Partial Forward operation of <a class="el" href="classmxnet_1_1Operator.html" title="Operator interface. Operator defines basic operation unit of optimized computation graph in mxnet...">Operator</a>. Only issue operation specified by step. The caller must keep calling PartialForward with increasing steps, until step_left=0. <a href="#a3e261d44065848e434c527000d4390c8">More...</a><br/></td></tr> |
| <tr class="separator:a3e261d44065848e434c527000d4390c8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa2fd32510a718aff38323e63be0d65e3"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#aa2fd32510a718aff38323e63be0d65e3">Backward</a> (const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > &head_grads, bool is_train=true)=0</td></tr> |
| <tr class="memdesc:aa2fd32510a718aff38323e63be0d65e3"><td class="mdescLeft"> </td><td class="mdescRight">Perform a Backward operation of the <a class="el" href="classmxnet_1_1Operator.html" title="Operator interface. Operator defines basic operation unit of optimized computation graph in mxnet...">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="#aa2fd32510a718aff38323e63be0d65e3">More...</a><br/></td></tr> |
| <tr class="separator:aa2fd32510a718aff38323e63be0d65e3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3803afcb87e4c69940c8d3d88a03e6ee"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#a3803afcb87e4c69940c8d3d88a03e6ee">Print</a> (std::ostream &os) const </td></tr> |
| <tr class="memdesc:a3803afcb87e4c69940c8d3d88a03e6ee"><td class="mdescLeft"> </td><td class="mdescRight">print the execution plan info to output stream. <a href="#a3803afcb87e4c69940c8d3d88a03e6ee">More...</a><br/></td></tr> |
| <tr class="separator:a3803afcb87e4c69940c8d3d88a03e6ee"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16d0f1ab276e32242685702aa10b9a3d"><td align="right" class="memItemLeft" valign="top">virtual const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#a16d0f1ab276e32242685702aa10b9a3d">outputs</a> () const =0</td></tr> |
| <tr class="memdesc:a16d0f1ab276e32242685702aa10b9a3d"><td class="mdescLeft"> </td><td class="mdescRight">get array of outputs in the executor. <a href="#a16d0f1ab276e32242685702aa10b9a3d">More...</a><br/></td></tr> |
| <tr class="separator:a16d0f1ab276e32242685702aa10b9a3d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a07a3e917596ed08718ee2859283c2476"><td align="right" class="memItemLeft" valign="top">virtual const std::unordered_map< std::string, <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#a07a3e917596ed08718ee2859283c2476">in_arg_map</a> () const =0</td></tr> |
| <tr class="memdesc:a07a3e917596ed08718ee2859283c2476"><td class="mdescLeft"> </td><td class="mdescRight">get input argument map, key is arg name, value is arg's <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a>. <a href="#a07a3e917596ed08718ee2859283c2476">More...</a><br/></td></tr> |
| <tr class="separator:a07a3e917596ed08718ee2859283c2476"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a84552a918a65633678f30c00a2a0ae7f"><td align="right" class="memItemLeft" valign="top">virtual const std::unordered_map< std::string, <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#a84552a918a65633678f30c00a2a0ae7f">arg_grad_map</a> () const =0</td></tr> |
| <tr class="memdesc:a84552a918a65633678f30c00a2a0ae7f"><td class="mdescLeft"> </td><td class="mdescRight">get input argument graident map, key is arg name, value is gradient's <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a>. <a href="#a84552a918a65633678f30c00a2a0ae7f">More...</a><br/></td></tr> |
| <tr class="separator:a84552a918a65633678f30c00a2a0ae7f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0a38a98fc4dcddc4205b5980ee7bdc4b"><td align="right" class="memItemLeft" valign="top">virtual const std::unordered_map< std::string, <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#a0a38a98fc4dcddc4205b5980ee7bdc4b">aux_state_map</a> () const =0</td></tr> |
| <tr class="memdesc:a0a38a98fc4dcddc4205b5980ee7bdc4b"><td class="mdescLeft"> </td><td class="mdescRight">get aux state map, key is arg name, value is aux state's <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a>. <a href="#a0a38a98fc4dcddc4205b5980ee7bdc4b">More...</a><br/></td></tr> |
| <tr class="separator:a0a38a98fc4dcddc4205b5980ee7bdc4b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3c701dda22a9c1e474d23b11edda9b0d"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#a3c701dda22a9c1e474d23b11edda9b0d">SetMonitorCallback</a> (const <a class="el" href="classmxnet_1_1Executor.html#a5684c74daafc9b80681cde6a9b7b4587">MonitorCallback</a> &callback)</td></tr> |
| <tr class="memdesc:a3c701dda22a9c1e474d23b11edda9b0d"><td class="mdescLeft"> </td><td class="mdescRight">Install a callback to notify the completion of operation. <a href="#a3c701dda22a9c1e474d23b11edda9b0d">More...</a><br/></td></tr> |
| <tr class="separator:a3c701dda22a9c1e474d23b11edda9b0d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a8217aa9fbdd99d107bd836872d7d9692"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="classmxnet_1_1Executor.html">Executor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#a8217aa9fbdd99d107bd836872d7d9692">Bind</a> (nnvm::Symbol symbol, const <a class="el" href="structmxnet_1_1Context.html">Context</a> &default_ctx, const std::map< std::string, <a class="el" href="structmxnet_1_1Context.html">Context</a> > &group2ctx, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > &in_args, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > &arg_grad_store, const std::vector< <a class="el" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398">OpReqType</a> > &grad_req_type, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > &aux_states, <a class="el" href="classmxnet_1_1Executor.html">Executor</a> *shared_exec=NULL)</td></tr> |
| <tr class="memdesc:a8217aa9fbdd99d107bd836872d7d9692"><td class="mdescLeft"> </td><td class="mdescRight">Create an operator by bind symbol with context and arguments. If user do not want to compute the gradients of i-th argument, grad_req_type[i] can be kNullOp. <a href="#a8217aa9fbdd99d107bd836872d7d9692">More...</a><br/></td></tr> |
| <tr class="separator:a8217aa9fbdd99d107bd836872d7d9692"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2aca59fcb5aa76b1626b52bd14f0a32c"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="classmxnet_1_1Executor.html">Executor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Executor.html#a2aca59fcb5aa76b1626b52bd14f0a32c">SimpleBind</a> (nnvm::Symbol symbol, const <a class="el" href="structmxnet_1_1Context.html">Context</a> &default_ctx, const std::map< std::string, <a class="el" href="structmxnet_1_1Context.html">Context</a> > &group2ctx, const std::vector< <a class="el" href="structmxnet_1_1Context.html">Context</a> > &in_arg_ctxes, const std::vector< <a class="el" href="structmxnet_1_1Context.html">Context</a> > &arg_grad_ctxes, const std::vector< <a class="el" href="structmxnet_1_1Context.html">Context</a> > &aux_state_ctxes, const std::unordered_map< std::string, <a class="el" href="namespacemxnet.html#a6e14bb5f6ffc81892feca8d1da658687">TShape</a> > &arg_shape_map, const std::unordered_map< std::string, int > &arg_dtype_map, const std::unordered_map< std::string, int > &arg_stype_map, const std::vector< <a class="el" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398">OpReqType</a> > &grad_req_types, const std::unordered_set< std::string > &param_names, std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > *in_args, std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > *arg_grads, std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > *aux_states, std::unordered_map< std::string, <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > *shared_data_arrays=nullptr, <a class="el" href="classmxnet_1_1Executor.html">Executor</a> *shared_exec=nullptr)</td></tr> |
| <tr class="separator:a2aca59fcb5aa76b1626b52bd14f0a32c"><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_1Executor.html" title="Executor of a computation graph. Executor can be created by Binding a symbol. ">Executor</a> of a computation graph. <a class="el" href="classmxnet_1_1Executor.html" title="Executor of a computation graph. Executor can be created by Binding a symbol. ">Executor</a> can be created by Binding a symbol. </p> |
| </div><h2 class="groupheader">Member Typedef Documentation</h2> |
| <a class="anchor" id="a5684c74daafc9b80681cde6a9b7b4587"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef std::function<void(const char*, void*)> <a class="el" href="classmxnet_1_1Executor.html#a5684c74daafc9b80681cde6a9b7b4587">mxnet::Executor::MonitorCallback</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>the prototype of user-defined monitor callback </p> |
| </div> |
| </div> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="adf445ff665c954061889d6bbee3c1c2a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual mxnet::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 class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>destructor </p> |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a84552a918a65633678f30c00a2a0ae7f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual const std::unordered_map<std::string, <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a>>& mxnet::Executor::arg_grad_map </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>get input argument graident map, key is arg name, value is gradient's <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a>. </p> |
| <dl class="section return"><dt>Returns</dt><dd>input argument gradient map in the executor. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a0a38a98fc4dcddc4205b5980ee7bdc4b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual const std::unordered_map<std::string, <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a>>& mxnet::Executor::aux_state_map </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>get aux state map, key is arg name, value is aux state's <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a>. </p> |
| <dl class="section return"><dt>Returns</dt><dd>aux state map in the executor. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="aa2fd32510a718aff38323e63be0d65e3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::Executor::Backward </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > & </td> |
| <td class="paramname"><em>head_grads</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>is_train</em> = <code>true</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Perform a Backward operation of the <a class="el" href="classmxnet_1_1Operator.html" title="Operator interface. Operator defines basic operation unit of optimized computation graph in mxnet...">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="a8217aa9fbdd99d107bd836872d7d9692"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classmxnet_1_1Executor.html">Executor</a>* mxnet::Executor::Bind </td> |
| <td>(</td> |
| <td class="paramtype">nnvm::Symbol </td> |
| <td class="paramname"><em>symbol</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structmxnet_1_1Context.html">Context</a> & </td> |
| <td class="paramname"><em>default_ctx</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::map< std::string, <a class="el" href="structmxnet_1_1Context.html">Context</a> > & </td> |
| <td class="paramname"><em>group2ctx</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > & </td> |
| <td class="paramname"><em>in_args</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > & </td> |
| <td class="paramname"><em>arg_grad_store</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398">OpReqType</a> > & </td> |
| <td class="paramname"><em>grad_req_type</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > & </td> |
| <td class="paramname"><em>aux_states</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1Executor.html">Executor</a> * </td> |
| <td class="paramname"><em>shared_exec</em> = <code>NULL</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Create an operator by bind symbol with context and arguments. If user do not want to compute the gradients of i-th argument, grad_req_type[i] can be kNullOp. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">default_ctx</td><td>the default context of binding. </td></tr> |
| <tr><td class="paramname">group2ctx</td><td><a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> mapping group to context. </td></tr> |
| <tr><td class="paramname">symbol</td><td>the symbol that specifies the output of Forward pass. </td></tr> |
| <tr><td class="paramname">in_args</td><td>the <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a> that stores the input arguments to the symbol. </td></tr> |
| <tr><td class="paramname">arg_grad_store</td><td><a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a> that is used to store the gradient output of the input arguments. </td></tr> |
| <tr><td class="paramname">grad_req_type</td><td>requirment type of gradient saving. Can only be in {kNullOp, kAddTo, kWriteTo}. </td></tr> |
| <tr><td class="paramname">aux_states</td><td><a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a> that is used as internal state in op </td></tr> |
| <tr><td class="paramname">shared_exec</td><td>input executor to share memory with. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a new executor. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="ab3716be8e6c265b091e618f46eeb6f9b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Perform a Forward operation of <a class="el" href="classmxnet_1_1Operator.html" title="Operator interface. Operator defines basic operation unit of optimized computation graph in mxnet...">Operator</a> After this operation, user can get the result by using function head. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a07a3e917596ed08718ee2859283c2476"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual const std::unordered_map<std::string, <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a>>& mxnet::Executor::in_arg_map </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>get input argument map, key is arg name, value is arg's <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a>. </p> |
| <dl class="section return"><dt>Returns</dt><dd>input argument map in the executor. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a16d0f1ab276e32242685702aa10b9a3d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual const std::vector<<a class="el" href="classmxnet_1_1NDArray.html">NDArray</a>>& mxnet::Executor::outputs </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>get array of outputs in the executor. </p> |
| <dl class="section return"><dt>Returns</dt><dd>array of outputs in the executor. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a3e261d44065848e434c527000d4390c8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::Executor::PartialForward </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>is_train</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>step</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int * </td> |
| <td class="paramname"><em>step_left</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Perform a Partial Forward operation of <a class="el" href="classmxnet_1_1Operator.html" title="Operator interface. Operator defines basic operation unit of optimized computation graph in mxnet...">Operator</a>. Only issue operation specified by step. The caller must keep calling PartialForward with increasing steps, until step_left=0. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">is_train</td><td>Whether this is training phase. </td></tr> |
| <tr><td class="paramname">step</td><td>current step, user can always start from 0 </td></tr> |
| <tr><td class="paramname">step_left</td><td>Number of steps left to finish the forward. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <a class="anchor" id="a3803afcb87e4c69940c8d3d88a03e6ee"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::Executor::Print </td> |
| <td>(</td> |
| <td class="paramtype">std::ostream & </td> |
| <td class="paramname"><em>os</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>print the execution plan info to output stream. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">os</td><td>the output stream we like to print to. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <a class="anchor" id="a3c701dda22a9c1e474d23b11edda9b0d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::Executor::SetMonitorCallback </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmxnet_1_1Executor.html#a5684c74daafc9b80681cde6a9b7b4587">MonitorCallback</a> & </td> |
| <td class="paramname"><em>callback</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Install a callback to notify the completion of operation. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a2aca59fcb5aa76b1626b52bd14f0a32c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classmxnet_1_1Executor.html">Executor</a>* mxnet::Executor::SimpleBind </td> |
| <td>(</td> |
| <td class="paramtype">nnvm::Symbol </td> |
| <td class="paramname"><em>symbol</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structmxnet_1_1Context.html">Context</a> & </td> |
| <td class="paramname"><em>default_ctx</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::map< std::string, <a class="el" href="structmxnet_1_1Context.html">Context</a> > & </td> |
| <td class="paramname"><em>group2ctx</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="structmxnet_1_1Context.html">Context</a> > & </td> |
| <td class="paramname"><em>in_arg_ctxes</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="structmxnet_1_1Context.html">Context</a> > & </td> |
| <td class="paramname"><em>arg_grad_ctxes</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="structmxnet_1_1Context.html">Context</a> > & </td> |
| <td class="paramname"><em>aux_state_ctxes</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::unordered_map< std::string, <a class="el" href="namespacemxnet.html#a6e14bb5f6ffc81892feca8d1da658687">TShape</a> > & </td> |
| <td class="paramname"><em>arg_shape_map</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::unordered_map< std::string, int > & </td> |
| <td class="paramname"><em>arg_dtype_map</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::unordered_map< std::string, int > & </td> |
| <td class="paramname"><em>arg_stype_map</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398">OpReqType</a> > & </td> |
| <td class="paramname"><em>grad_req_types</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::unordered_set< std::string > & </td> |
| <td class="paramname"><em>param_names</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > * </td> |
| <td class="paramname"><em>in_args</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > * </td> |
| <td class="paramname"><em>arg_grads</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > * </td> |
| <td class="paramname"><em>aux_states</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::unordered_map< std::string, <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > * </td> |
| <td class="paramname"><em>shared_data_arrays</em> = <code>nullptr</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmxnet_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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>include/mxnet/<a class="el" href="include_2mxnet_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:08:39 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> |
