blob: 17f6abcbea5aaa0efd7fd7d219c0a9471de9fc6b [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: cpp-package/include/mxnet-cpp/executor.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_c9bbcf2f7c4ed40b1b23631ec8abffa6.html">cpp-package</a></li><li class="navelem"><a class="el" href="dir_eb07344824255b98f70969533c25e736.html">include</a></li><li class="navelem"><a class="el" href="dir_0327d24fd86e9ce22567ad8f859e5290.html">mxnet-cpp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">executor.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="cpp-package_2include_2mxnet-cpp_2executor_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="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifndef MXNET_CPP_EXECUTOR_H_</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define MXNET_CPP_EXECUTOR_H_</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</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;map&gt;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include &lt;set&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 "<a class="code" href="cpp-package_2include_2mxnet-cpp_2base_8h.html">mxnet-cpp/base.h</a>"</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "<a class="code" href="symbol_8h.html">mxnet-cpp/symbol.h</a>"</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span><a class="code" href="namespacemxnet.html">mxnet</a> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span>cpp {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>Optimizer;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html"> 44</a></span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1cpp_1_1Executor.html">Executor</a> {</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html#a1aceee49824f6ba6ea0d4b26a8ebe1d4"> 45</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1cpp_1_1Monitor.html">Monitor</a>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a86cd99024edf91d7554f28c5e128dc7e">Executor</a>(<span class="keyword">const</span> <a class="code" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> &amp;symbol, <a class="code" href="classmxnet_1_1cpp_1_1Context.html">Context</a> context,</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">const</span> std::vector&lt;NDArray&gt; &amp;<a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a13d04b04cfafce126946be071549ace9">arg_arrays</a>,</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">const</span> std::vector&lt;NDArray&gt; &amp;<a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a42694f583467b2b517ea8f8c0250655b">grad_arrays</a>,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">const</span> std::vector&lt;OpReqType&gt; &amp;grad_reqs,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">const</span> std::vector&lt;NDArray&gt; &amp;<a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a11cc4c29bb7d5f859e9bbb4bc0df51ab">aux_arrays</a>,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">const</span> std::map&lt;std::string, Context&gt; &amp;group_to_ctx =</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  std::map&lt;std::string, Context&gt;(),</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classmxnet_1_1cpp_1_1Executor.html">Executor</a> *shared_exec = <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html#aefeb9bc416efd9aa6547e746d54724c1"> 55</a></span>  <span class="keyword">explicit</span> <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#aefeb9bc416efd9aa6547e746d54724c1">Executor</a>(<span class="keyword">const</span> <a class="code" href="c__api_8h.html#a6f224ee35892507405ced8429d874726">ExecutorHandle</a> &amp;h) { handle_ = h; }</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html#a1fef41367238aaf8315fe5715a9f8f47"> 60</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a1fef41367238aaf8315fe5715a9f8f47">Forward</a>(<span class="keywordtype">bool</span> is_train) {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="c__api_8h.html#a1f9987e701b810e0e79b5207fa215415">MXExecutorForward</a>(handle_, is_train ? 1 : 0);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="c__api_8h.html#a796e7ef8260ef40b24af7d1082aa2d84">mx_uint</a> out_size;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="c__api_8h.html#a99c2939783499d2a5ce0d76881dce9df">NDArrayHandle</a> *out_array;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  CHECK_EQ(<a class="code" href="c__api_8h.html#a442845c8ef89d4c849f468ea2b7717f7">MXExecutorOutputs</a>(handle_, &amp;out_size, &amp;out_array), 0);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">for</span> (<a class="code" href="c__api_8h.html#a796e7ef8260ef40b24af7d1082aa2d84">mx_uint</a> i = 0; i &lt; out_size; ++i) {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#ac8da23a16e33e0e75a44f803cd3b7933">outputs</a>[i] = <a class="code" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>(out_array[i]);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  }</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html#abd98fc4f87cd8adea049a31a840898e4"> 79</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#abd98fc4f87cd8adea049a31a840898e4">Backward</a>(<span class="keyword">const</span> std::vector&lt;NDArray&gt; &amp;head_grads =</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  std::vector&lt;NDArray&gt;()) {</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  std::vector&lt;NDArrayHandle&gt; head_grads_;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span> d : head_grads) {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  head_grads_.push_back(d.GetHandle());</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  }</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">if</span> (head_grads_.size() &gt; 0) {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="c__api_8h.html#ad8f92bb15e11058abe12959cfc4dcbb3">MXExecutorBackward</a>(handle_, head_grads_.size(), head_grads_.data());</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="c__api_8h.html#ad8f92bb15e11058abe12959cfc4dcbb3">MXExecutorBackward</a>(handle_, 0, <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  }</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">// TODO(zhangchen-qinyinghua)</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// To implement reshape function</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#aa4e594bc8b840f03c148aa84c472cb99">Reshape</a>();</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  std::string <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#aa9ffb2228d9a552a43277704dcf2ad64">DebugStr</a>();</div><div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html#ad6a26ffaabff769ee829221ef47e29e6"> 102</a></span>  <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#ad6a26ffaabff769ee829221ef47e29e6">~Executor</a>() { <a class="code" href="c__api_8h.html#ade1487656dfba3cae12c5bf676e08dcf">MXExecutorFree</a>(handle_); }</div><div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html#a13d04b04cfafce126946be071549ace9"> 103</a></span>  std::vector&lt;NDArray&gt; <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a13d04b04cfafce126946be071549ace9">arg_arrays</a>;</div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html#a42694f583467b2b517ea8f8c0250655b"> 104</a></span>  std::vector&lt;NDArray&gt; <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a42694f583467b2b517ea8f8c0250655b">grad_arrays</a>;</div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html#a11cc4c29bb7d5f859e9bbb4bc0df51ab"> 105</a></span>  std::vector&lt;NDArray&gt; <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a11cc4c29bb7d5f859e9bbb4bc0df51ab">aux_arrays</a>;</div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html#ac8da23a16e33e0e75a44f803cd3b7933"> 109</a></span>  std::vector&lt;NDArray&gt; <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#ac8da23a16e33e0e75a44f803cd3b7933">outputs</a>;</div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html#a942ef73436ecb2bcfde588e004037963"> 110</a></span>  std::map&lt;std::string, NDArray&gt; <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a942ef73436ecb2bcfde588e004037963">arg_dict</a>() {</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordflow">return</span> GetDict(symbol_.<a class="code" href="classmxnet_1_1cpp_1_1Symbol.html#a2f32bfc88aa91c3fd3729d219bb0fa98">ListArguments</a>(), <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a13d04b04cfafce126946be071549ace9">arg_arrays</a>);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div><div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html#a4ca4e8a5517ac2a35824adda6c80f872"> 113</a></span>  std::map&lt;std::string, NDArray&gt; <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a4ca4e8a5517ac2a35824adda6c80f872">grad_dict</a>() {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">return</span> GetDict(symbol_.<a class="code" href="classmxnet_1_1cpp_1_1Symbol.html#a2f32bfc88aa91c3fd3729d219bb0fa98">ListArguments</a>(), <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a42694f583467b2b517ea8f8c0250655b">grad_arrays</a>);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  }</div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1Executor.html#a6c6ef2d2f79c26fd0bad949243f7a37a"> 116</a></span>  std::map&lt;std::string, NDArray&gt; <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a6c6ef2d2f79c26fd0bad949243f7a37a">aux_dict</a>() {</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">return</span> GetDict(symbol_.<a class="code" href="classmxnet_1_1cpp_1_1Symbol.html#ae6c870b37a1329b6ba372a8b719ea500">ListAuxiliaryStates</a>(), <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a11cc4c29bb7d5f859e9bbb4bc0df51ab">aux_arrays</a>);</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="classmxnet_1_1cpp_1_1Executor.html#a86cd99024edf91d7554f28c5e128dc7e">Executor</a>(<span class="keyword">const</span> <a class="code" href="classmxnet_1_1cpp_1_1Executor.html">Executor</a> &amp;e);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <a class="code" href="classmxnet_1_1cpp_1_1Executor.html">Executor</a> &amp;operator=(<span class="keyword">const</span> <a class="code" href="classmxnet_1_1cpp_1_1Executor.html">Executor</a> &amp;e);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="c__api_8h.html#a6f224ee35892507405ced8429d874726">ExecutorHandle</a> handle_;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <a class="code" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> symbol_;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  std::map&lt;std::string, NDArray&gt; GetDict(<span class="keyword">const</span> std::vector&lt;std::string&gt; &amp;names,</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">const</span> std::vector&lt;NDArray&gt; &amp;arrays) {</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  std::map&lt;std::string, NDArray&gt; ret;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  std::set&lt;std::string&gt; name_set;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span> &amp;s : names) {</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  CHECK(name_set.find(s) == name_set.end()) &lt;&lt; <span class="stringliteral">"Duplicate names detected, "</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  &lt;&lt; s;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  name_set.insert(s);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  }</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  CHECK_EQ(name_set.size(), arrays.size())</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  &lt;&lt; <span class="stringliteral">"names size not equal to arrays size"</span>;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; names.size(); ++i) {</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  ret[names[i]] = arrays[i];</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  }</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> };</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> } <span class="comment">// namespace cpp</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> } <span class="comment">// namespace mxnet</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor">#endif // MXNET_CPP_EXECUTOR_H_</span></div><div class="ttc" id="symbol_8h_html"><div class="ttname"><a href="symbol_8h.html">symbol.h</a></div><div class="ttdoc">definition of symbol </div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_ac8da23a16e33e0e75a44f803cd3b7933"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#ac8da23a16e33e0e75a44f803cd3b7933">mxnet::cpp::Executor::outputs</a></div><div class="ttdeci">std::vector&lt; NDArray &gt; outputs</div><div class="ttdoc">arrays store the outputs of forward </div><div class="ttdef"><b>Definition:</b> executor.h:109</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_a1fef41367238aaf8315fe5715a9f8f47"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#a1fef41367238aaf8315fe5715a9f8f47">mxnet::cpp::Executor::Forward</a></div><div class="ttdeci">void Forward(bool is_train)</div><div class="ttdoc">Perform a Forward operation of Operator After this operation, user can get the result by using functi...</div><div class="ttdef"><b>Definition:</b> executor.h:60</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_a42694f583467b2b517ea8f8c0250655b"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#a42694f583467b2b517ea8f8c0250655b">mxnet::cpp::Executor::grad_arrays</a></div><div class="ttdeci">std::vector&lt; NDArray &gt; grad_arrays</div><div class="ttdef"><b>Definition:</b> executor.h:104</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:126</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html">mxnet::cpp::Executor</a></div><div class="ttdoc">Executor interface. </div><div class="ttdef"><b>Definition:</b> executor.h:44</div></div>
<div class="ttc" id="c__api_8h_html_a442845c8ef89d4c849f468ea2b7717f7"><div class="ttname"><a href="c__api_8h.html#a442845c8ef89d4c849f468ea2b7717f7">MXExecutorOutputs</a></div><div class="ttdeci">MXNET_DLL int MXExecutorOutputs(ExecutorHandle handle, mx_uint *out_size, NDArrayHandle **out)</div><div class="ttdoc">Get executor&amp;#39;s head NDArray. </div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_a86cd99024edf91d7554f28c5e128dc7e"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#a86cd99024edf91d7554f28c5e128dc7e">mxnet::cpp::Executor::Executor</a></div><div class="ttdeci">Executor(const Symbol &amp;symbol, Context context, const std::vector&lt; NDArray &gt; &amp;arg_arrays, const std::vector&lt; NDArray &gt; &amp;grad_arrays, const std::vector&lt; OpReqType &gt; &amp;grad_reqs, const std::vector&lt; NDArray &gt; &amp;aux_arrays, const std::map&lt; std::string, Context &gt; &amp;group_to_ctx=std::map&lt; std::string, Context &gt;(), Executor *shared_exec=nullptr)</div></div>
<div class="ttc" id="c__api_8h_html_a6f224ee35892507405ced8429d874726"><div class="ttname"><a href="c__api_8h.html#a6f224ee35892507405ced8429d874726">ExecutorHandle</a></div><div class="ttdeci">void * ExecutorHandle</div><div class="ttdoc">handle to an Executor </div><div class="ttdef"><b>Definition:</b> c_api.h:76</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_a13d04b04cfafce126946be071549ace9"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#a13d04b04cfafce126946be071549ace9">mxnet::cpp::Executor::arg_arrays</a></div><div class="ttdeci">std::vector&lt; NDArray &gt; arg_arrays</div><div class="ttdef"><b>Definition:</b> executor.h:103</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Symbol_html_a2f32bfc88aa91c3fd3729d219bb0fa98"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Symbol.html#a2f32bfc88aa91c3fd3729d219bb0fa98">mxnet::cpp::Symbol::ListArguments</a></div><div class="ttdeci">std::vector&lt; std::string &gt; ListArguments() const </div><div class="ttdoc">List the arguments names. </div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_aa9ffb2228d9a552a43277704dcf2ad64"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#aa9ffb2228d9a552a43277704dcf2ad64">mxnet::cpp::Executor::DebugStr</a></div><div class="ttdeci">std::string DebugStr()</div><div class="ttdoc">update the arguments with given learning rate and optimizer </div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1NDArray_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1NDArray.html">mxnet::cpp::NDArray</a></div><div class="ttdoc">NDArray interface. </div><div class="ttdef"><b>Definition:</b> ndarray.h:120</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_a6c6ef2d2f79c26fd0bad949243f7a37a"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#a6c6ef2d2f79c26fd0bad949243f7a37a">mxnet::cpp::Executor::aux_dict</a></div><div class="ttdeci">std::map&lt; std::string, NDArray &gt; aux_dict()</div><div class="ttdef"><b>Definition:</b> executor.h:116</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Symbol_html_ae6c870b37a1329b6ba372a8b719ea500"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Symbol.html#ae6c870b37a1329b6ba372a8b719ea500">mxnet::cpp::Symbol::ListAuxiliaryStates</a></div><div class="ttdeci">std::vector&lt; std::string &gt; ListAuxiliaryStates() const </div></div>
<div class="ttc" id="c__api_8h_html_a99c2939783499d2a5ce0d76881dce9df"><div class="ttname"><a href="c__api_8h.html#a99c2939783499d2a5ce0d76881dce9df">NDArrayHandle</a></div><div class="ttdeci">void * NDArrayHandle</div><div class="ttdoc">handle to NDArray </div><div class="ttdef"><b>Definition:</b> c_api.h:64</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_a11cc4c29bb7d5f859e9bbb4bc0df51ab"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#a11cc4c29bb7d5f859e9bbb4bc0df51ab">mxnet::cpp::Executor::aux_arrays</a></div><div class="ttdeci">std::vector&lt; NDArray &gt; aux_arrays</div><div class="ttdef"><b>Definition:</b> executor.h:105</div></div>
<div class="ttc" id="c__api_8h_html_a796e7ef8260ef40b24af7d1082aa2d84"><div class="ttname"><a href="c__api_8h.html#a796e7ef8260ef40b24af7d1082aa2d84">mx_uint</a></div><div class="ttdeci">unsigned int mx_uint</div><div class="ttdoc">manually define unsigned int </div><div class="ttdef"><b>Definition:</b> c_api.h:57</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Monitor_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Monitor.html">mxnet::cpp::Monitor</a></div><div class="ttdoc">Monitor interface. </div><div class="ttdef"><b>Definition:</b> monitor.h:54</div></div>
<div class="ttc" id="c__api_8h_html_ad8f92bb15e11058abe12959cfc4dcbb3"><div class="ttname"><a href="c__api_8h.html#ad8f92bb15e11058abe12959cfc4dcbb3">MXExecutorBackward</a></div><div class="ttdeci">MXNET_DLL int MXExecutorBackward(ExecutorHandle handle, mx_uint len, NDArrayHandle *head_grads)</div><div class="ttdoc">Excecutor run backward. </div></div>
<div class="ttc" id="cpp-package_2include_2mxnet-cpp_2base_8h_html"><div class="ttname"><a href="cpp-package_2include_2mxnet-cpp_2base_8h.html">base.h</a></div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_a4ca4e8a5517ac2a35824adda6c80f872"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#a4ca4e8a5517ac2a35824adda6c80f872">mxnet::cpp::Executor::grad_dict</a></div><div class="ttdeci">std::map&lt; std::string, NDArray &gt; grad_dict()</div><div class="ttdef"><b>Definition:</b> executor.h:113</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_abd98fc4f87cd8adea049a31a840898e4"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#abd98fc4f87cd8adea049a31a840898e4">mxnet::cpp::Executor::Backward</a></div><div class="ttdeci">void Backward(const std::vector&lt; NDArray &gt; &amp;head_grads=std::vector&lt; NDArray &gt;())</div><div class="ttdoc">Perform a Backward operation of the Operator. This must be called after Forward. After this operation...</div><div class="ttdef"><b>Definition:</b> executor.h:79</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_aa4e594bc8b840f03c148aa84c472cb99"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#aa4e594bc8b840f03c148aa84c472cb99">mxnet::cpp::Executor::Reshape</a></div><div class="ttdeci">void Reshape()</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_aefeb9bc416efd9aa6547e746d54724c1"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#aefeb9bc416efd9aa6547e746d54724c1">mxnet::cpp::Executor::Executor</a></div><div class="ttdeci">Executor(const ExecutorHandle &amp;h)</div><div class="ttdef"><b>Definition:</b> executor.h:55</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_a942ef73436ecb2bcfde588e004037963"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#a942ef73436ecb2bcfde588e004037963">mxnet::cpp::Executor::arg_dict</a></div><div class="ttdeci">std::map&lt; std::string, NDArray &gt; arg_dict()</div><div class="ttdef"><b>Definition:</b> executor.h:110</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Context_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Context.html">mxnet::cpp::Context</a></div><div class="ttdoc">Context interface. </div><div class="ttdef"><b>Definition:</b> ndarray.h:49</div></div>
<div class="ttc" id="c__api_8h_html_ade1487656dfba3cae12c5bf676e08dcf"><div class="ttname"><a href="c__api_8h.html#ade1487656dfba3cae12c5bf676e08dcf">MXExecutorFree</a></div><div class="ttdeci">MXNET_DLL int MXExecutorFree(ExecutorHandle handle)</div><div class="ttdoc">Delete the executor. </div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Symbol_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Symbol.html">mxnet::cpp::Symbol</a></div><div class="ttdoc">Symbol interface. </div><div class="ttdef"><b>Definition:</b> symbol.h:71</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1Executor_html_ad6a26ffaabff769ee829221ef47e29e6"><div class="ttname"><a href="classmxnet_1_1cpp_1_1Executor.html#ad6a26ffaabff769ee829221ef47e29e6">mxnet::cpp::Executor::~Executor</a></div><div class="ttdeci">~Executor()</div><div class="ttdoc">destructor, free the handle </div><div class="ttdef"><b>Definition:</b> executor.h:102</div></div>
<div class="ttc" id="c__api_8h_html_a1f9987e701b810e0e79b5207fa215415"><div class="ttname"><a href="c__api_8h.html#a1f9987e701b810e0e79b5207fa215415">MXExecutorForward</a></div><div class="ttdeci">MXNET_DLL int MXExecutorForward(ExecutorHandle handle, int is_train)</div><div class="ttdoc">Executor forward method. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Sep 19 2019 13:11:20 for mxnet by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="doxygen.png"/>
</a> 1.8.11
</small></address>
</body>
</html>