| <!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 http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: mxnet::Imperative Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></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 cellspacing="0" cellpadding="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.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <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 src="classmxnet_1_1Imperative__coll__graph.png" border="0" usemap="#mxnet_1_1Imperative_coll__map" alt="Collaboration graph"/></div> |
| <map name="mxnet_1_1Imperative_coll__map" id="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 class="memItemLeft" align="right" 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:af6024ec51f5fcd73935994f7b43f62ef"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#af6024ec51f5fcd73935994f7b43f62ef">is_training</a> () const</td></tr> |
| <tr class="memdesc:af6024ec51f5fcd73935994f7b43f62ef"><td class="mdescLeft"> </td><td class="mdescRight">whether operator recording is on. <a href="#af6024ec51f5fcd73935994f7b43f62ef">More...</a><br /></td></tr> |
| <tr class="separator:af6024ec51f5fcd73935994f7b43f62ef"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2c1495dbdc4439fd534307fa981b77f0"><td class="memItemLeft" align="right" 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:acbbd0eafd83cd96a40cce3d01147b1a3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#acbbd0eafd83cd96a40cce3d01147b1a3">is_recording</a> () const</td></tr> |
| <tr class="memdesc:acbbd0eafd83cd96a40cce3d01147b1a3"><td class="mdescLeft"> </td><td class="mdescRight">whether operator recording is on. <a href="#acbbd0eafd83cd96a40cce3d01147b1a3">More...</a><br /></td></tr> |
| <tr class="separator:acbbd0eafd83cd96a40cce3d01147b1a3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abc9227372b3d4f4b5ec8ed33ba6e68ad"><td class="memItemLeft" align="right" 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#acbbd0eafd83cd96a40cce3d01147b1a3">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:af65cc2bc2b45b328d99ba443211b8be7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#af65cc2bc2b45b328d99ba443211b8be7">is_np_shape</a> () const</td></tr> |
| <tr class="memdesc:af65cc2bc2b45b328d99ba443211b8be7"><td class="mdescLeft"> </td><td class="mdescRight">return current numpy compatibility status, GlobalOn(2), ThreadLocalOn(1), Off(0). <a href="#af65cc2bc2b45b328d99ba443211b8be7">More...</a><br /></td></tr> |
| <tr class="separator:af65cc2bc2b45b328d99ba443211b8be7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a63ff2923f4b9daa8c35d1a683d17949f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#a63ff2923f4b9daa8c35d1a683d17949f">is_np_default_dtype</a> () const</td></tr> |
| <tr class="memdesc:a63ff2923f4b9daa8c35d1a683d17949f"><td class="mdescLeft"> </td><td class="mdescRight">return current numpy default dtype compatibility status. <a href="#a63ff2923f4b9daa8c35d1a683d17949f">More...</a><br /></td></tr> |
| <tr class="separator:a63ff2923f4b9daa8c35d1a683d17949f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afc403b976f76aae9dcfc3790d9190832"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#afc403b976f76aae9dcfc3790d9190832">set_is_np_shape</a> (int <a class="el" href="classmxnet_1_1Imperative.html#af65cc2bc2b45b328d99ba443211b8be7">is_np_shape</a>)</td></tr> |
| <tr class="memdesc:afc403b976f76aae9dcfc3790d9190832"><td class="mdescLeft"> </td><td class="mdescRight">specify numpy compatibility off, thread local on or global on. <a href="#afc403b976f76aae9dcfc3790d9190832">More...</a><br /></td></tr> |
| <tr class="separator:afc403b976f76aae9dcfc3790d9190832"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6a5049338d4099646f226dc0f7581fd6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#a6a5049338d4099646f226dc0f7581fd6">RecordOp</a> (<a class="el" href="structnnvm_1_1NodeAttrs.html">nnvm::NodeAttrs</a> &&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:a6a5049338d4099646f226dc0f7581fd6"><td class="mdescLeft"> </td><td class="mdescRight">to record operator, return corresponding node. <a href="#a6a5049338d4099646f226dc0f7581fd6">More...</a><br /></td></tr> |
| <tr class="separator:a6a5049338d4099646f226dc0f7581fd6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a34590f2f00e376c5ae639f6c2ce8cbac"><td class="memItemLeft" align="right" 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#a34590f2f00e376c5ae639f6c2ce8cbac">Invoke</a> (const <a class="el" href="structmxnet_1_1Context.html">Context</a> &default_ctx, const <a class="el" href="structnnvm_1_1NodeAttrs.html">nnvm::NodeAttrs</a> &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:a34590f2f00e376c5ae639f6c2ce8cbac"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5bac6cd4fa515ed9f87c548e4695fad6"><td class="memItemLeft" align="right" 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#a5bac6cd4fa515ed9f87c548e4695fad6">InvokeOp</a> (const <a class="el" href="structmxnet_1_1Context.html">Context</a> &ctx, const <a class="el" href="structnnvm_1_1NodeAttrs.html">nnvm::NodeAttrs</a> &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:a5bac6cd4fa515ed9f87c548e4695fad6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2980bfd35324c33b209ad80fc8bc9b7c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative.html#a2980bfd35324c33b209ad80fc8bc9b7c">MarkVariables</a> (const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> *> &variables, const std::vector< uint32_t > &grad_reqs, const std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> *> &gradients)</td></tr> |
| <tr class="memdesc:a2980bfd35324c33b209ad80fc8bc9b7c"><td class="mdescLeft"> </td><td class="mdescRight">mark variables for computing gradients. <a href="#a2980bfd35324c33b209ad80fc8bc9b7c">More...</a><br /></td></tr> |
| <tr class="separator:a2980bfd35324c33b209ad80fc8bc9b7c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9d0c9270045476391b61c8ca3762e552"><td class="memItemLeft" align="right" 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#a9d0c9270045476391b61c8ca3762e552">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:a9d0c9270045476391b61c8ca3762e552"><td class="mdescLeft"> </td><td class="mdescRight">compute the gradient of outputs w.r.t variables. <a href="#a9d0c9270045476391b61c8ca3762e552">More...</a><br /></td></tr> |
| <tr class="separator:a9d0c9270045476391b61c8ca3762e552"><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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 name="details" id="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 id="a9d0c9270045476391b61c8ca3762e552"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9d0c9270045476391b61c8ca3762e552">◆ </a></span>Backward()</h2> |
| |
| <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 id="a482d9ab2ab7d969c55f7c13797a662a0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a482d9ab2ab7d969c55f7c13797a662a0">◆ </a></span>BulkExecMaxNodeTrainBwd()</h2> |
| |
| <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 id="af19dbcd37d7adf9d205b9c2efdb84b6b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af19dbcd37d7adf9d205b9c2efdb84b6b">◆ </a></span>BulkExecMaxNodeTrainFwd()</h2> |
| |
| <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 id="a55cc9d57cddd0aeae5771e1c7d72b00d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a55cc9d57cddd0aeae5771e1c7d72b00d">◆ </a></span>Get()</h2> |
| |
| <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 id="a34590f2f00e376c5ae639f6c2ce8cbac"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a34590f2f00e376c5ae639f6c2ce8cbac">◆ </a></span>Invoke()</h2> |
| |
| <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 <a class="el" href="structnnvm_1_1NodeAttrs.html">nnvm::NodeAttrs</a> & </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 id="a5bac6cd4fa515ed9f87c548e4695fad6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5bac6cd4fa515ed9f87c548e4695fad6">◆ </a></span>InvokeOp()</h2> |
| |
| <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 <a class="el" href="structnnvm_1_1NodeAttrs.html">nnvm::NodeAttrs</a> & </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 id="a63ff2923f4b9daa8c35d1a683d17949f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a63ff2923f4b9daa8c35d1a683d17949f">◆ </a></span>is_np_default_dtype()</h2> |
| |
| <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_default_dtype </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>return current numpy default dtype compatibility status. </p> |
| |
| </div> |
| </div> |
| <a id="af65cc2bc2b45b328d99ba443211b8be7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af65cc2bc2b45b328d99ba443211b8be7">◆ </a></span>is_np_shape()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int 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>return current numpy compatibility status, GlobalOn(2), ThreadLocalOn(1), Off(0). </p> |
| |
| </div> |
| </div> |
| <a id="acbbd0eafd83cd96a40cce3d01147b1a3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acbbd0eafd83cd96a40cce3d01147b1a3">◆ </a></span>is_recording()</h2> |
| |
| <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 id="af6024ec51f5fcd73935994f7b43f62ef"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af6024ec51f5fcd73935994f7b43f62ef">◆ </a></span>is_training()</h2> |
| |
| <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 id="a2980bfd35324c33b209ad80fc8bc9b7c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2980bfd35324c33b209ad80fc8bc9b7c">◆ </a></span>MarkVariables()</h2> |
| |
| <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< uint32_t > & </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 id="a0b5c5c6c9e7288156a7c633cb5433900"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0b5c5c6c9e7288156a7c633cb5433900">◆ </a></span>PreferBulkExecInference()</h2> |
| |
| <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 id="a99b8ef35060523298e8e7e969d829920"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a99b8ef35060523298e8e7e969d829920">◆ </a></span>PreferBulkExecTrain()</h2> |
| |
| <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 id="a6a5049338d4099646f226dc0f7581fd6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6a5049338d4099646f226dc0f7581fd6">◆ </a></span>RecordOp()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mxnet::Imperative::RecordOp </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structnnvm_1_1NodeAttrs.html">nnvm::NodeAttrs</a> && </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 id="afc403b976f76aae9dcfc3790d9190832"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afc403b976f76aae9dcfc3790d9190832">◆ </a></span>set_is_np_shape()</h2> |
| |
| <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">int </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>specify numpy compatibility off, thread local on or global on. </p> |
| |
| </div> |
| </div> |
| <a id="abc9227372b3d4f4b5ec8ed33ba6e68ad"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abc9227372b3d4f4b5ec8ed33ba6e68ad">◆ </a></span>set_is_recording()</h2> |
| |
| <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 id="a2c1495dbdc4439fd534307fa981b77f0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2c1495dbdc4439fd534307fa981b77f0">◆ </a></span>set_is_training()</h2> |
| |
| <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 id="ad41557e205cf8f4d6ef70b60587c37cb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad41557e205cf8f4d6ef70b60587c37cb">◆ </a></span>NDArray</h2> |
| |
| <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>/work/mxnet/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 Jan 5 2023 00:58:44 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
