| <!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::Imperative 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="pages.html"><span>Related Pages</span></a></li> |
| <li><a href="modules.html"><span>Modules</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_1Imperative.html">Imperative</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classmxnet_1_1Imperative-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::Imperative Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <p>runtime functions for <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a> |
| <a href="classmxnet_1_1Imperative.html#details">More...</a></p> |
| <p><code>#include <<a class="el" href="imperative_8h_source.html">imperative.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::Imperative:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="Collaboration graph" border="0" src="classmxnet_1_1Imperative__coll__graph.png" usemap="#mxnet_1_1Imperative_coll__map"/></div> |
| <map id="mxnet_1_1Imperative_coll__map" name="mxnet_1_1Imperative_coll__map"> |
| </map> |
| </div> |
| <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_1Imperative_1_1AGInfo.html">AGInfo</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="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a05de0382a6aecf2cb8ee1c0a7c021bae"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#a05de0382a6aecf2cb8ee1c0a7c021bae">is_training</a> () const </td></tr> |
| <tr class="memdesc:a05de0382a6aecf2cb8ee1c0a7c021bae"><td class="mdescLeft"> </td><td class="mdescRight">whether operator recording is on. <a href="#a05de0382a6aecf2cb8ee1c0a7c021bae">More...</a><br/></td></tr> |
| <tr class="separator:a05de0382a6aecf2cb8ee1c0a7c021bae"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2c1495dbdc4439fd534307fa981b77f0"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#a2c1495dbdc4439fd534307fa981b77f0">set_is_training</a> (bool is_train)</td></tr> |
| <tr class="memdesc:a2c1495dbdc4439fd534307fa981b77f0"><td class="mdescLeft"> </td><td class="mdescRight">turn on or turn off operator recording for autograd. <a href="#a2c1495dbdc4439fd534307fa981b77f0">More...</a><br/></td></tr> |
| <tr class="separator:a2c1495dbdc4439fd534307fa981b77f0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a62790da5baceaad22abdf23326770239"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#a62790da5baceaad22abdf23326770239">is_recording</a> () const </td></tr> |
| <tr class="memdesc:a62790da5baceaad22abdf23326770239"><td class="mdescLeft"> </td><td class="mdescRight">whether operator recording is on. <a href="#a62790da5baceaad22abdf23326770239">More...</a><br/></td></tr> |
| <tr class="separator:a62790da5baceaad22abdf23326770239"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abc9227372b3d4f4b5ec8ed33ba6e68ad"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#abc9227372b3d4f4b5ec8ed33ba6e68ad">set_is_recording</a> (bool <a class="el" href="classmxnet_1_1Imperative.html#a62790da5baceaad22abdf23326770239">is_recording</a>)</td></tr> |
| <tr class="memdesc:abc9227372b3d4f4b5ec8ed33ba6e68ad"><td class="mdescLeft"> </td><td class="mdescRight">turn on or turn off operator recording for autograd. <a href="#abc9227372b3d4f4b5ec8ed33ba6e68ad">More...</a><br/></td></tr> |
| <tr class="separator:abc9227372b3d4f4b5ec8ed33ba6e68ad"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa3703d3d283ade74c85efead444e314e"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#aa3703d3d283ade74c85efead444e314e">is_np_shape</a> () const </td></tr> |
| <tr class="separator:aa3703d3d283ade74c85efead444e314e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af42019a5dcb5799b46aa2164237b8aec"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#af42019a5dcb5799b46aa2164237b8aec">set_is_np_shape</a> (bool <a class="el" href="classmxnet_1_1Imperative.html#aa3703d3d283ade74c85efead444e314e">is_np_shape</a>)</td></tr> |
| <tr class="separator:af42019a5dcb5799b46aa2164237b8aec"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2b0f55c31882412c44468d8ba1a97fd1"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#a2b0f55c31882412c44468d8ba1a97fd1">RecordOp</a> (nnvm::NodeAttrs &&attrs, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > &inputs, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > &outputs, const <a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a> &state=<a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a>(), std::vector< bool > *p_save_inputs=nullptr, std::vector< bool > *p_save_outputs=nullptr)</td></tr> |
| <tr class="memdesc:a2b0f55c31882412c44468d8ba1a97fd1"><td class="mdescLeft"> </td><td class="mdescRight">to record operator, return corresponding node. <a href="#a2b0f55c31882412c44468d8ba1a97fd1">More...</a><br/></td></tr> |
| <tr class="separator:a2b0f55c31882412c44468d8ba1a97fd1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae3a1279e546061bf6062817c93dce0dc"><td align="right" class="memItemLeft" valign="top"><a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#ae3a1279e546061bf6062817c93dce0dc">Invoke</a> (const <a class="el" href="structmxnet_1_1Context.html">Context</a> &default_ctx, const nnvm::NodeAttrs &attrs, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > &inputs, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > &outputs)</td></tr> |
| <tr class="separator:ae3a1279e546061bf6062817c93dce0dc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adb41ed890acd4cbe672f088b0284fe84"><td align="right" class="memItemLeft" valign="top"><a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#adb41ed890acd4cbe672f088b0284fe84">InvokeOp</a> (const <a class="el" href="structmxnet_1_1Context.html">Context</a> &ctx, const nnvm::NodeAttrs &attrs, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > &inputs, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > &outputs, const std::vector< <a class="el" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398">OpReqType</a> > &req, const <a class="el" href="namespacemxnet.html#aad5fec2b4bceabbf4b884460cc2e0a2b">DispatchMode</a> dispatch_mode, <a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a> state=<a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a>())</td></tr> |
| <tr class="separator:adb41ed890acd4cbe672f088b0284fe84"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa8c469ce724fb0c0aa27078e84428416"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#aa8c469ce724fb0c0aa27078e84428416">MarkVariables</a> (const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > &variables, const std::vector< <a class="el" href="c__api_8h.html#a796e7ef8260ef40b24af7d1082aa2d84">mx_uint</a> > &grad_reqs, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > &gradients)</td></tr> |
| <tr class="memdesc:aa8c469ce724fb0c0aa27078e84428416"><td class="mdescLeft"> </td><td class="mdescRight">mark variables for computing gradients. <a href="#aa8c469ce724fb0c0aa27078e84428416">More...</a><br/></td></tr> |
| <tr class="separator:aa8c469ce724fb0c0aa27078e84428416"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afa4950a3cf57431f1d0d639c3f7afa7d"><td align="right" class="memItemLeft" valign="top">std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#afa4950a3cf57431f1d0d639c3f7afa7d">Backward</a> (const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > &outputs, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > &ograds, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > &variables, bool is_train, bool retain_graph, bool create_graph)</td></tr> |
| <tr class="memdesc:afa4950a3cf57431f1d0d639c3f7afa7d"><td class="mdescLeft"> </td><td class="mdescRight">compute the gradient of outputs w.r.t variables. <a href="#afa4950a3cf57431f1d0d639c3f7afa7d">More...</a><br/></td></tr> |
| <tr class="separator:afa4950a3cf57431f1d0d639c3f7afa7d"><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:a55cc9d57cddd0aeae5771e1c7d72b00d"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="classmxnet_1_1Imperative.html">Imperative</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#a55cc9d57cddd0aeae5771e1c7d72b00d">Get</a> ()</td></tr> |
| <tr class="separator:a55cc9d57cddd0aeae5771e1c7d72b00d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0b5c5c6c9e7288156a7c633cb5433900"><td align="right" class="memItemLeft" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#a0b5c5c6c9e7288156a7c633cb5433900">PreferBulkExecInference</a> ()</td></tr> |
| <tr class="memdesc:a0b5c5c6c9e7288156a7c633cb5433900"><td class="mdescLeft"> </td><td class="mdescRight">Should op execution bulking be employed during inference. <a href="#a0b5c5c6c9e7288156a7c633cb5433900">More...</a><br/></td></tr> |
| <tr class="separator:a0b5c5c6c9e7288156a7c633cb5433900"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a99b8ef35060523298e8e7e969d829920"><td align="right" class="memItemLeft" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#a99b8ef35060523298e8e7e969d829920">PreferBulkExecTrain</a> ()</td></tr> |
| <tr class="memdesc:a99b8ef35060523298e8e7e969d829920"><td class="mdescLeft"> </td><td class="mdescRight">Should op execution bulking be employed during training. <a href="#a99b8ef35060523298e8e7e969d829920">More...</a><br/></td></tr> |
| <tr class="separator:a99b8ef35060523298e8e7e969d829920"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af19dbcd37d7adf9d205b9c2efdb84b6b"><td align="right" class="memItemLeft" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#af19dbcd37d7adf9d205b9c2efdb84b6b">BulkExecMaxNodeTrainFwd</a> ()</td></tr> |
| <tr class="memdesc:af19dbcd37d7adf9d205b9c2efdb84b6b"><td class="mdescLeft"> </td><td class="mdescRight">The max number of op nodes in a bulk during forward pass of training. <a href="#af19dbcd37d7adf9d205b9c2efdb84b6b">More...</a><br/></td></tr> |
| <tr class="separator:af19dbcd37d7adf9d205b9c2efdb84b6b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a482d9ab2ab7d969c55f7c13797a662a0"><td align="right" class="memItemLeft" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#a482d9ab2ab7d969c55f7c13797a662a0">BulkExecMaxNodeTrainBwd</a> ()</td></tr> |
| <tr class="memdesc:a482d9ab2ab7d969c55f7c13797a662a0"><td class="mdescLeft"> </td><td class="mdescRight">The max number of op nodes in a bulk during backward pass of training. <a href="#a482d9ab2ab7d969c55f7c13797a662a0">More...</a><br/></td></tr> |
| <tr class="separator:a482d9ab2ab7d969c55f7c13797a662a0"><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:ad41557e205cf8f4d6ef70b60587c37cb"><td align="right" class="memItemLeft" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#ad41557e205cf8f4d6ef70b60587c37cb">NDArray</a></td></tr> |
| <tr class="separator:ad41557e205cf8f4d6ef70b60587c37cb"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>runtime functions for <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a> </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="afa4950a3cf57431f1d0d639c3f7afa7d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<<a class="el" href="classmxnet_1_1NDArray.html">NDArray</a>*> mxnet::Imperative::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>outputs</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>ograds</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>variables</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></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">bool </td> |
| <td class="paramname"><em>retain_graph</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>create_graph</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>compute the gradient of outputs w.r.t variables. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a482d9ab2ab7d969c55f7c13797a662a0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static int mxnet::Imperative::BulkExecMaxNodeTrainBwd </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">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The max number of op nodes in a bulk during backward pass of training. </p> |
| </div> |
| </div> |
| <a class="anchor" id="af19dbcd37d7adf9d205b9c2efdb84b6b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static int mxnet::Imperative::BulkExecMaxNodeTrainFwd </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">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The max number of op nodes in a bulk during forward pass of training. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a55cc9d57cddd0aeae5771e1c7d72b00d"></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_1Imperative.html">Imperative</a>* mxnet::Imperative::Get </td> |
| <td>(</td> |
| <td class="paramname"></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"> |
| <dl class="section return"><dt>Returns</dt><dd>AutogradRuntime singleton </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="ae3a1279e546061bf6062817c93dce0dc"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a> mxnet::Imperative::Invoke </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 nnvm::NodeAttrs & </td> |
| <td class="paramname"><em>attrs</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>inputs</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>outputs</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="adb41ed890acd4cbe672f088b0284fe84"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a> mxnet::Imperative::InvokeOp </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structmxnet_1_1Context.html">Context</a> & </td> |
| <td class="paramname"><em>ctx</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const nnvm::NodeAttrs & </td> |
| <td class="paramname"><em>attrs</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>inputs</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>outputs</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>req</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="namespacemxnet.html#aad5fec2b4bceabbf4b884460cc2e0a2b">DispatchMode</a> </td> |
| <td class="paramname"><em>dispatch_mode</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a> </td> |
| <td class="paramname"><em>state</em> = <code><a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a>()</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="aa3703d3d283ade74c85efead444e314e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mxnet::Imperative::is_np_shape </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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>brief whether numpy compatibility is on. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a62790da5baceaad22abdf23326770239"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mxnet::Imperative::is_recording </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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>whether operator recording is on. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a05de0382a6aecf2cb8ee1c0a7c021bae"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mxnet::Imperative::is_training </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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>whether operator recording is on. </p> |
| </div> |
| </div> |
| <a class="anchor" id="aa8c469ce724fb0c0aa27078e84428416"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mxnet::Imperative::MarkVariables </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * > & </td> |
| <td class="paramname"><em>variables</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="c__api_8h.html#a796e7ef8260ef40b24af7d1082aa2d84">mx_uint</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_1NDArray.html">NDArray</a> * > & </td> |
| <td class="paramname"><em>gradients</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>mark variables for computing gradients. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a0b5c5c6c9e7288156a7c633cb5433900"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static bool mxnet::Imperative::PreferBulkExecInference </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">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Should op execution bulking be employed during inference. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a99b8ef35060523298e8e7e969d829920"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static bool mxnet::Imperative::PreferBulkExecTrain </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">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Should op execution bulking be employed during training. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a2b0f55c31882412c44468d8ba1a97fd1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mxnet::Imperative::RecordOp </td> |
| <td>(</td> |
| <td class="paramtype">nnvm::NodeAttrs && </td> |
| <td class="paramname"><em>attrs</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>inputs</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>outputs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a> & </td> |
| <td class="paramname"><em>state</em> = <code><a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a>()</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< bool > * </td> |
| <td class="paramname"><em>p_save_inputs</em> = <code>nullptr</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< bool > * </td> |
| <td class="paramname"><em>p_save_outputs</em> = <code>nullptr</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>to record operator, return corresponding node. </p> |
| </div> |
| </div> |
| <a class="anchor" id="af42019a5dcb5799b46aa2164237b8aec"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mxnet::Imperative::set_is_np_shape </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>is_np_shape</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>brief turn on or turn off numpy compatibility switch. </p> |
| </div> |
| </div> |
| <a class="anchor" id="abc9227372b3d4f4b5ec8ed33ba6e68ad"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mxnet::Imperative::set_is_recording </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>is_recording</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>turn on or turn off operator recording for autograd. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a2c1495dbdc4439fd534307fa981b77f0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mxnet::Imperative::set_is_training </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>turn on or turn off operator recording for autograd. </p> |
| </div> |
| </div> |
| <h2 class="groupheader">Friends And Related Function Documentation</h2> |
| <a class="anchor" id="ad41557e205cf8f4d6ef70b60587c37cb"></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_1NDArray.html">NDArray</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> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>include/mxnet/<a class="el" href="imperative_8h_source.html">imperative.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Sep 19 2019 12:25:12 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> |
