blob: ae4c86063a8cf3bd00db7df74530eed05da42ac7 [file] [log] [blame]
<!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: include/mxnet/imperative.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script src="jquery.js" type="text/javascript"></script>
<script src="dynsections.js" type="text/javascript"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script src="search/searchdata.js" type="text/javascript"></script>
<script src="search/search.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellpadding="0" cellspacing="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div class="tabs" id="navrow1">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div class="MSearchBoxInactive" id="MSearchBox">
<span class="left">
<img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/>
<input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/>
</span><span class="right">
<a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a>
</span>
</div>
</li>
</ul>
</div>
<div class="tabs2" id="navrow2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)">
</iframe>
</div>
<div class="navpath" id="nav-path">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">imperative.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="imperative_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * under the License.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef MXNET_IMPERATIVE_H_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define MXNET_IMPERATIVE_H_</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include &lt;<a class="code" href="op__attr__types_8h.html">mxnet/op_attr_types.h</a>&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include &lt;<a class="code" href="graph__attr__types_8h.html">mxnet/graph_attr_types.h</a>&gt;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include &lt;<a class="code" href="c__api_8h.html">mxnet/c_api.h</a>&gt;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include &lt;nnvm/symbolic.h&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include &lt;nnvm/op.h&gt;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include &lt;nnvm/graph.h&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include &lt;atomic&gt;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include &lt;utility&gt;</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include &lt;unordered_map&gt;</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "<a class="code" href="include_2mxnet_2ndarray_8h.html">./ndarray.h</a>"</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span><a class="code" href="namespacemxnet.html">mxnet</a> {</div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1Imperative.html">Imperative</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html"> 42</a></span>  <span class="keyword">class </span><a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html">AGInfo</a> {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html#afe2cb4d45bd32e40a86d2a49bfd20952"> 44</a></span>  <a class="code" href="structmxnet_1_1Context.html">Context</a> <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#afe2cb4d45bd32e40a86d2a49bfd20952">ctx</a>;</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html#ad1da7fe0f83dbe5eb89770460c985a64"> 45</a></span>  <a class="code" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398">OpReqType</a> <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#ad1da7fe0f83dbe5eb89770460c985a64">grad_req</a>;</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html#a027a81d4864241f12ae79388efd482da"> 46</a></span>  <a class="code" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a> <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a027a81d4864241f12ae79388efd482da">state</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html#a2ca114d69098860adc900ba5f54c4cb5"> 47</a></span>  std::vector&lt;NDArray&gt; <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a2ca114d69098860adc900ba5f54c4cb5">outputs</a>;</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html#a694cd90f3a43ac0014fa4913da56c499"> 48</a></span>  std::vector&lt;NDArray&gt; <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a694cd90f3a43ac0014fa4913da56c499">out_grads</a>;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html#aa98f7d65123fb64697769cfb952de310"> 49</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#aa98f7d65123fb64697769cfb952de310">fresh_out_grad</a>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html#a30ae688e0b9e1b9fb506db3a4a7c23fe"> 51</a></span>  <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a30ae688e0b9e1b9fb506db3a4a7c23fe">AGInfo</a>() :</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  grad_req(<a class="code" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398a001b85096e07108e174fe4c406368a26">kNullOp</a>), fresh_out_grad(false) {}</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html#ac1285664cc551c266fdc506fa8f8e8ad"> 54</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#ac1285664cc551c266fdc506fa8f8e8ad">Clear</a>(<span class="keyword">const</span> nnvm::NodePtr&amp; node) {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">if</span> (node == <span class="keyword">nullptr</span> || node-&gt;info.empty()) <span class="keywordflow">return</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html">AGInfo</a>&amp; info = <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a8fae98f49d45ae32d885b3c0574a40db">Get</a>(node);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">if</span> (info.<a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#ad1da7fe0f83dbe5eb89770460c985a64">grad_req</a> != <a class="code" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398a001b85096e07108e174fe4c406368a26">kNullOp</a>) <span class="keywordflow">return</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  node-&gt;info.clear();</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html#a8fae98f49d45ae32d885b3c0574a40db"> 61</a></span>  <span class="keyword">static</span> <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html">AGInfo</a>&amp; <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a8fae98f49d45ae32d885b3c0574a40db">Get</a>(<span class="keyword">const</span> nnvm::NodePtr&amp; node) {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">return</span> dmlc::get&lt;AGInfo&gt;(node-&gt;info);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html#a8204823e44c4b44b08c276bddfcbb952"> 65</a></span>  <span class="keyword">static</span> <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html">AGInfo</a>&amp; <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a8204823e44c4b44b08c276bddfcbb952">Create</a>(<span class="keyword">const</span> nnvm::NodePtr&amp; node) {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  node-&gt;info.construct&lt;<a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html">AGInfo</a>&gt;();</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">return</span> <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a8fae98f49d45ae32d885b3c0574a40db">Get</a>(node);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html#afca370cc8b3e93f950d04df6e29f1fdc"> 70</a></span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#afca370cc8b3e93f950d04df6e29f1fdc">IsNone</a>(<span class="keyword">const</span> <a class="code" href="classmxnet_1_1NDArray.html">NDArray</a>&amp; arr) {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">return</span> arr.entry_.node == <span class="keyword">nullptr</span> || arr.entry_.node-&gt;info.empty();</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative_1_1AGInfo.html#ad5f1d672e9adc8c0be46cc4002c0aafc"> 74</a></span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#ad5f1d672e9adc8c0be46cc4002c0aafc">IsVariable</a>(<span class="keyword">const</span> nnvm::NodePtr&amp; node) {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html">AGInfo</a>&amp; info = <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a8fae98f49d45ae32d885b3c0574a40db">Get</a>(node);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">return</span> info.<a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#ad1da7fe0f83dbe5eb89770460c985a64">grad_req</a> != <a class="code" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398a001b85096e07108e174fe4c406368a26">kNullOp</a> &amp;&amp; info.<a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a2ca114d69098860adc900ba5f54c4cb5">outputs</a>.size() == 1</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  &amp;&amp; info.<a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a694cd90f3a43ac0014fa4913da56c499">out_grads</a>.size() == 1;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  }</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  };</div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative.html#a05de0382a6aecf2cb8ee1c0a7c021bae"> 81</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmxnet_1_1Imperative.html#a05de0382a6aecf2cb8ee1c0a7c021bae">is_training</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> is_train_;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative.html#a2c1495dbdc4439fd534307fa981b77f0"> 85</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmxnet_1_1Imperative.html#a2c1495dbdc4439fd534307fa981b77f0">set_is_training</a>(<span class="keywordtype">bool</span> is_train) {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">bool</span> old = is_train_;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  is_train_ = is_train;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span> old;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative.html#a62790da5baceaad22abdf23326770239"> 91</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmxnet_1_1Imperative.html#a62790da5baceaad22abdf23326770239">is_recording</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">return</span> is_recording_;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div><div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative.html#abc9227372b3d4f4b5ec8ed33ba6e68ad"> 95</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmxnet_1_1Imperative.html#abc9227372b3d4f4b5ec8ed33ba6e68ad">set_is_recording</a>(<span class="keywordtype">bool</span> <a class="code" href="classmxnet_1_1Imperative.html#a62790da5baceaad22abdf23326770239">is_recording</a>) {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">bool</span> old = is_recording_;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  is_recording_ = <a class="code" href="classmxnet_1_1Imperative.html#a62790da5baceaad22abdf23326770239">is_recording</a>;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">return</span> old;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  }</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Imperative.html#a2b0f55c31882412c44468d8ba1a97fd1">RecordOp</a>(nnvm::NodeAttrs&amp;&amp; attrs,</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; inputs,</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a2ca114d69098860adc900ba5f54c4cb5">outputs</a>,</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">const</span> <a class="code" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a>&amp; <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a027a81d4864241f12ae79388efd482da">state</a> = <a class="code" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a>(),</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  std::vector&lt;bool&gt;* p_save_inputs = <span class="keyword">nullptr</span>,</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  std::vector&lt;bool&gt;* p_save_outputs = <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="code" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a> <a class="code" href="classmxnet_1_1Imperative.html#ae3a1279e546061bf6062817c93dce0dc">Invoke</a>(<span class="keyword">const</span> <a class="code" href="structmxnet_1_1Context.html">Context</a>&amp; default_ctx,</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">const</span> nnvm::NodeAttrs&amp; attrs,</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; inputs,</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; outputs);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a> <a class="code" href="classmxnet_1_1Imperative.html#adb41ed890acd4cbe672f088b0284fe84">InvokeOp</a>(<span class="keyword">const</span> <a class="code" href="structmxnet_1_1Context.html">Context</a>&amp; <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#afe2cb4d45bd32e40a86d2a49bfd20952">ctx</a>,</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">const</span> nnvm::NodeAttrs&amp; attrs,</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; inputs,</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; outputs,</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">const</span> std::vector&lt;OpReqType&gt;&amp; req,</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">const</span> <a class="code" href="namespacemxnet.html#aad5fec2b4bceabbf4b884460cc2e0a2b">DispatchMode</a> dispatch_mode,</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a> <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a027a81d4864241f12ae79388efd482da">state</a> = <a class="code" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a>());</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Imperative.html#aa8c469ce724fb0c0aa27078e84428416">MarkVariables</a>(<span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; variables,</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">const</span> std::vector&lt;mx_uint&gt;&amp; grad_reqs,</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; gradients);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  std::vector&lt;NDArray*&gt; <a class="code" href="classmxnet_1_1Imperative.html#afa4950a3cf57431f1d0d639c3f7afa7d">Backward</a>(<span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; outputs,</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; ograds,</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; variables,</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">bool</span> is_train, <span class="keywordtype">bool</span> retain_graph,</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">bool</span> create_graph);</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">static</span> <a class="code" href="classmxnet_1_1Imperative.html">Imperative</a>* <a class="code" href="classmxnet_1_1Imperative_1_1AGInfo.html#a8fae98f49d45ae32d885b3c0574a40db">Get</a>();</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="classmxnet_1_1Imperative.html#ad41557e205cf8f4d6ef70b60587c37cb"> 134</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1NDArray.html">NDArray</a>;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <a class="code" href="classmxnet_1_1Imperative.html">Imperative</a>() {</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordflow">if</span> (dmlc::GetEnv(<span class="stringliteral">"MXNET_EXEC_BULK_EXEC_TRAIN"</span>, 1)) {</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  backward_bulk_size_ = dmlc::GetEnv(<span class="stringliteral">"MXNET_EXEC_BULK_EXEC_MAX_NODE_TRAIN"</span>, 15);</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  }</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  }</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordtype">void</span> GetBackwardDependency(</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">const</span> nnvm::NodePtr&amp; node,</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  uint32_t num_inputs, uint32_t num_outputs,</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  std::vector&lt;bool&gt; *p_save_inputs,</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  std::vector&lt;bool&gt; *p_save_outputs);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor">#if DMLC_CXX11_THREAD_LOCAL</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keyword">static</span> thread_local <span class="keywordtype">bool</span> is_train_;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keyword">static</span> thread_local <span class="keywordtype">bool</span> is_recording_;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">static</span> MX_THREAD_LOCAL <span class="keywordtype">bool</span> is_train_;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keyword">static</span> MX_THREAD_LOCAL <span class="keywordtype">bool</span> is_recording_;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  std::atomic&lt;uint64_t&gt; node_count_{0};</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  std::atomic&lt;uint64_t&gt; variable_count_{0};</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">int</span> backward_bulk_size_{0};</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> };</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> } <span class="comment">// namespace mxnet</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="preprocessor">#endif // MXNET_IMPERATIVE_H_</span></div><div class="ttc" id="c__api_8h_html"><div class="ttname"><a href="c__api_8h.html">c_api.h</a></div><div class="ttdoc">C API of mxnet. </div></div>
<div class="ttc" id="classmxnet_1_1Imperative_html_a62790da5baceaad22abdf23326770239"><div class="ttname"><a href="classmxnet_1_1Imperative.html#a62790da5baceaad22abdf23326770239">mxnet::Imperative::is_recording</a></div><div class="ttdeci">bool is_recording() const </div><div class="ttdoc">whether operator recording is on. </div><div class="ttdef"><b>Definition:</b> imperative.h:91</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html_afca370cc8b3e93f950d04df6e29f1fdc"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html#afca370cc8b3e93f950d04df6e29f1fdc">mxnet::Imperative::AGInfo::IsNone</a></div><div class="ttdeci">static bool IsNone(const NDArray &amp;arr)</div><div class="ttdef"><b>Definition:</b> imperative.h:70</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html_a8204823e44c4b44b08c276bddfcbb952"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html#a8204823e44c4b44b08c276bddfcbb952">mxnet::Imperative::AGInfo::Create</a></div><div class="ttdeci">static AGInfo &amp; Create(const nnvm::NodePtr &amp;node)</div><div class="ttdef"><b>Definition:</b> imperative.h:65</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_html_a05de0382a6aecf2cb8ee1c0a7c021bae"><div class="ttname"><a href="classmxnet_1_1Imperative.html#a05de0382a6aecf2cb8ee1c0a7c021bae">mxnet::Imperative::is_training</a></div><div class="ttdeci">bool is_training() const </div><div class="ttdoc">whether operator recording is on. </div><div class="ttdef"><b>Definition:</b> imperative.h:81</div></div>
<div class="ttc" id="namespacemxnet_html_a7cd7094ef222e9ae1f520c3b6a214398a001b85096e07108e174fe4c406368a26"><div class="ttname"><a href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398a001b85096e07108e174fe4c406368a26">mxnet::kNullOp</a></div><div class="ttdoc">no operation, do not write anything </div><div class="ttdef"><b>Definition:</b> op_attr_types.h:47</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_html_a2c1495dbdc4439fd534307fa981b77f0"><div class="ttname"><a href="classmxnet_1_1Imperative.html#a2c1495dbdc4439fd534307fa981b77f0">mxnet::Imperative::set_is_training</a></div><div class="ttdeci">bool set_is_training(bool is_train)</div><div class="ttdoc">turn on or turn off operator recording for autograd. </div><div class="ttdef"><b>Definition:</b> imperative.h:85</div></div>
<div class="ttc" id="namespacemxnet_html"><div class="ttname"><a href="namespacemxnet.html">mxnet</a></div><div class="ttdoc">namespace of mxnet </div><div class="ttdef"><b>Definition:</b> base.h:118</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_html_afa4950a3cf57431f1d0d639c3f7afa7d"><div class="ttname"><a href="classmxnet_1_1Imperative.html#afa4950a3cf57431f1d0d639c3f7afa7d">mxnet::Imperative::Backward</a></div><div class="ttdeci">std::vector&lt; NDArray * &gt; Backward(const std::vector&lt; NDArray * &gt; &amp;outputs, const std::vector&lt; NDArray * &gt; &amp;ograds, const std::vector&lt; NDArray * &gt; &amp;variables, bool is_train, bool retain_graph, bool create_graph)</div><div class="ttdoc">compute the gradient of outputs w.r.t variables. </div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html_ac1285664cc551c266fdc506fa8f8e8ad"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html#ac1285664cc551c266fdc506fa8f8e8ad">mxnet::Imperative::AGInfo::Clear</a></div><div class="ttdeci">static void Clear(const nnvm::NodePtr &amp;node)</div><div class="ttdef"><b>Definition:</b> imperative.h:54</div></div>
<div class="ttc" id="op__attr__types_8h_html"><div class="ttname"><a href="op__attr__types_8h.html">op_attr_types.h</a></div><div class="ttdoc">Additional operator attributes beside the ones provided by NNVM. </div></div>
<div class="ttc" id="classmxnet_1_1Imperative_html_ae3a1279e546061bf6062817c93dce0dc"><div class="ttname"><a href="classmxnet_1_1Imperative.html#ae3a1279e546061bf6062817c93dce0dc">mxnet::Imperative::Invoke</a></div><div class="ttdeci">OpStatePtr Invoke(const Context &amp;default_ctx, const nnvm::NodeAttrs &amp;attrs, const std::vector&lt; NDArray * &gt; &amp;inputs, const std::vector&lt; NDArray * &gt; &amp;outputs)</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html_a30ae688e0b9e1b9fb506db3a4a7c23fe"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html#a30ae688e0b9e1b9fb506db3a4a7c23fe">mxnet::Imperative::AGInfo::AGInfo</a></div><div class="ttdeci">AGInfo()</div><div class="ttdef"><b>Definition:</b> imperative.h:51</div></div>
<div class="ttc" id="namespacemxnet_html_aad5fec2b4bceabbf4b884460cc2e0a2b"><div class="ttname"><a href="namespacemxnet.html#aad5fec2b4bceabbf4b884460cc2e0a2b">mxnet::DispatchMode</a></div><div class="ttdeci">DispatchMode</div><div class="ttdoc">the dispatch mode of the operator </div><div class="ttdef"><b>Definition:</b> op_attr_types.h:113</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html_a2ca114d69098860adc900ba5f54c4cb5"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html#a2ca114d69098860adc900ba5f54c4cb5">mxnet::Imperative::AGInfo::outputs</a></div><div class="ttdeci">std::vector&lt; NDArray &gt; outputs</div><div class="ttdef"><b>Definition:</b> imperative.h:47</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html">mxnet::Imperative::AGInfo</a></div><div class="ttdef"><b>Definition:</b> imperative.h:42</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_html_abc9227372b3d4f4b5ec8ed33ba6e68ad"><div class="ttname"><a href="classmxnet_1_1Imperative.html#abc9227372b3d4f4b5ec8ed33ba6e68ad">mxnet::Imperative::set_is_recording</a></div><div class="ttdeci">bool set_is_recording(bool is_recording)</div><div class="ttdoc">turn on or turn off operator recording for autograd. </div><div class="ttdef"><b>Definition:</b> imperative.h:95</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html_aa98f7d65123fb64697769cfb952de310"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html#aa98f7d65123fb64697769cfb952de310">mxnet::Imperative::AGInfo::fresh_out_grad</a></div><div class="ttdeci">bool fresh_out_grad</div><div class="ttdef"><b>Definition:</b> imperative.h:49</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html_a027a81d4864241f12ae79388efd482da"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html#a027a81d4864241f12ae79388efd482da">mxnet::Imperative::AGInfo::state</a></div><div class="ttdeci">OpStatePtr state</div><div class="ttdef"><b>Definition:</b> imperative.h:46</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html_a694cd90f3a43ac0014fa4913da56c499"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html#a694cd90f3a43ac0014fa4913da56c499">mxnet::Imperative::AGInfo::out_grads</a></div><div class="ttdeci">std::vector&lt; NDArray &gt; out_grads</div><div class="ttdef"><b>Definition:</b> imperative.h:48</div></div>
<div class="ttc" id="graph__attr__types_8h_html"><div class="ttname"><a href="graph__attr__types_8h.html">graph_attr_types.h</a></div><div class="ttdoc">Data structures that can appear in graph attributes. </div></div>
<div class="ttc" id="classmxnet_1_1Imperative_html_a2b0f55c31882412c44468d8ba1a97fd1"><div class="ttname"><a href="classmxnet_1_1Imperative.html#a2b0f55c31882412c44468d8ba1a97fd1">mxnet::Imperative::RecordOp</a></div><div class="ttdeci">void RecordOp(nnvm::NodeAttrs &amp;&amp;attrs, const std::vector&lt; NDArray * &gt; &amp;inputs, const std::vector&lt; NDArray * &gt; &amp;outputs, const OpStatePtr &amp;state=OpStatePtr(), std::vector&lt; bool &gt; *p_save_inputs=nullptr, std::vector&lt; bool &gt; *p_save_outputs=nullptr)</div><div class="ttdoc">to record operator, return corresponding node. </div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html_ad1da7fe0f83dbe5eb89770460c985a64"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html#ad1da7fe0f83dbe5eb89770460c985a64">mxnet::Imperative::AGInfo::grad_req</a></div><div class="ttdeci">OpReqType grad_req</div><div class="ttdef"><b>Definition:</b> imperative.h:45</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html_afe2cb4d45bd32e40a86d2a49bfd20952"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html#afe2cb4d45bd32e40a86d2a49bfd20952">mxnet::Imperative::AGInfo::ctx</a></div><div class="ttdeci">Context ctx</div><div class="ttdef"><b>Definition:</b> imperative.h:44</div></div>
<div class="ttc" id="namespacemxnet_html_a7cd7094ef222e9ae1f520c3b6a214398"><div class="ttname"><a href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398">mxnet::OpReqType</a></div><div class="ttdeci">OpReqType</div><div class="ttdoc">operation request type to Forward and Backward </div><div class="ttdef"><b>Definition:</b> op_attr_types.h:45</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_html_adb41ed890acd4cbe672f088b0284fe84"><div class="ttname"><a href="classmxnet_1_1Imperative.html#adb41ed890acd4cbe672f088b0284fe84">mxnet::Imperative::InvokeOp</a></div><div class="ttdeci">OpStatePtr InvokeOp(const Context &amp;ctx, const nnvm::NodeAttrs &amp;attrs, const std::vector&lt; NDArray * &gt; &amp;inputs, const std::vector&lt; NDArray * &gt; &amp;outputs, const std::vector&lt; OpReqType &gt; &amp;req, const DispatchMode dispatch_mode, OpStatePtr state=OpStatePtr())</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html_ad5f1d672e9adc8c0be46cc4002c0aafc"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html#ad5f1d672e9adc8c0be46cc4002c0aafc">mxnet::Imperative::AGInfo::IsVariable</a></div><div class="ttdeci">static bool IsVariable(const nnvm::NodePtr &amp;node)</div><div class="ttdef"><b>Definition:</b> imperative.h:74</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_html"><div class="ttname"><a href="classmxnet_1_1Imperative.html">mxnet::Imperative</a></div><div class="ttdoc">runtime functions for NDArray </div><div class="ttdef"><b>Definition:</b> imperative.h:39</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_1_1AGInfo_html_a8fae98f49d45ae32d885b3c0574a40db"><div class="ttname"><a href="classmxnet_1_1Imperative_1_1AGInfo.html#a8fae98f49d45ae32d885b3c0574a40db">mxnet::Imperative::AGInfo::Get</a></div><div class="ttdeci">static AGInfo &amp; Get(const nnvm::NodePtr &amp;node)</div><div class="ttdef"><b>Definition:</b> imperative.h:61</div></div>
<div class="ttc" id="classmxnet_1_1Imperative_html_aa8c469ce724fb0c0aa27078e84428416"><div class="ttname"><a href="classmxnet_1_1Imperative.html#aa8c469ce724fb0c0aa27078e84428416">mxnet::Imperative::MarkVariables</a></div><div class="ttdeci">void MarkVariables(const std::vector&lt; NDArray * &gt; &amp;variables, const std::vector&lt; mx_uint &gt; &amp;grad_reqs, const std::vector&lt; NDArray * &gt; &amp;gradients)</div><div class="ttdoc">mark variables for computing gradients. </div></div>
<div class="ttc" id="structmxnet_1_1Context_html"><div class="ttname"><a href="structmxnet_1_1Context.html">mxnet::Context</a></div><div class="ttdoc">Context information about the execution environment. </div><div class="ttdef"><b>Definition:</b> base.h:133</div></div>
<div class="ttc" id="include_2mxnet_2ndarray_8h_html"><div class="ttname"><a href="include_2mxnet_2ndarray_8h.html">ndarray.h</a></div></div>
<div class="ttc" id="classmxnet_1_1NDArray_html"><div class="ttname"><a href="classmxnet_1_1NDArray.html">mxnet::NDArray</a></div><div class="ttdoc">ndarray interface </div><div class="ttdef"><b>Definition:</b> ndarray.h:82</div></div>
<div class="ttc" id="classmxnet_1_1OpStatePtr_html"><div class="ttname"><a href="classmxnet_1_1OpStatePtr.html">mxnet::OpStatePtr</a></div><div class="ttdoc">Operator state. This is a pointer type, its content is mutable even if OpStatePtr is const...</div><div class="ttdef"><b>Definition:</b> op_attr_types.h:129</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Sep 19 2019 12:37:33 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>