blob: 055e16adaa45c8933d60fe334d605c958d7e8a33 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: mxnet::Imperative::AGInfo 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.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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><li class="navelem"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html">AGInfo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classmxnet_1_1Imperative_1_1AGInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::Imperative::AGInfo Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="imperative_8h_source.html">imperative.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::Imperative::AGInfo:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1Imperative_1_1AGInfo__coll__graph.png" border="0" usemap="#mxnet_1_1Imperative_1_1AGInfo_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</div>
<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:a30ae688e0b9e1b9fb506db3a4a7c23fe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html#a30ae688e0b9e1b9fb506db3a4a7c23fe">AGInfo</a> ()</td></tr>
<tr class="separator:a30ae688e0b9e1b9fb506db3a4a7c23fe"><td class="memSeparator" colspan="2">&#160;</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:adcb3d1fe4326161d1f797b5646ab05e6"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html#adcb3d1fe4326161d1f797b5646ab05e6">Clear</a> (const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;node)</td></tr>
<tr class="separator:adcb3d1fe4326161d1f797b5646ab05e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42f1896f9cf21cfc6192b6db200ba2c4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html">AGInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html#a42f1896f9cf21cfc6192b6db200ba2c4">Get</a> (const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;node)</td></tr>
<tr class="separator:a42f1896f9cf21cfc6192b6db200ba2c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01bf316282c6d229f033e9d394772293"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html">AGInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html#a01bf316282c6d229f033e9d394772293">Create</a> (const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;node)</td></tr>
<tr class="separator:a01bf316282c6d229f033e9d394772293"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afca370cc8b3e93f950d04df6e29f1fdc"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html#afca370cc8b3e93f950d04df6e29f1fdc">IsNone</a> (const <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> &amp;arr)</td></tr>
<tr class="separator:afca370cc8b3e93f950d04df6e29f1fdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cbce8aa6881a4cbc9ff736e3a3e7b35"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html#a9cbce8aa6881a4cbc9ff736e3a3e7b35">IsVariable</a> (const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;node)</td></tr>
<tr class="separator:a9cbce8aa6881a4cbc9ff736e3a3e7b35"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:afe2cb4d45bd32e40a86d2a49bfd20952"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmxnet_1_1Context.html">Context</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html#afe2cb4d45bd32e40a86d2a49bfd20952">ctx</a></td></tr>
<tr class="separator:afe2cb4d45bd32e40a86d2a49bfd20952"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1da7fe0f83dbe5eb89770460c985a64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398">OpReqType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html#ad1da7fe0f83dbe5eb89770460c985a64">grad_req</a></td></tr>
<tr class="separator:ad1da7fe0f83dbe5eb89770460c985a64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a027a81d4864241f12ae79388efd482da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1OpStatePtr.html">OpStatePtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html#a027a81d4864241f12ae79388efd482da">state</a></td></tr>
<tr class="separator:a027a81d4864241f12ae79388efd482da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ca114d69098860adc900ba5f54c4cb5"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html#a2ca114d69098860adc900ba5f54c4cb5">outputs</a></td></tr>
<tr class="separator:a2ca114d69098860adc900ba5f54c4cb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a694cd90f3a43ac0014fa4913da56c499"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html#a694cd90f3a43ac0014fa4913da56c499">out_grads</a></td></tr>
<tr class="separator:a694cd90f3a43ac0014fa4913da56c499"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa98f7d65123fb64697769cfb952de310"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1AGInfo.html#aa98f7d65123fb64697769cfb952de310">fresh_out_grad</a></td></tr>
<tr class="separator:aa98f7d65123fb64697769cfb952de310"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a30ae688e0b9e1b9fb506db3a4a7c23fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30ae688e0b9e1b9fb506db3a4a7c23fe">&#9670;&nbsp;</a></span>AGInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::Imperative::AGInfo::AGInfo </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> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="adcb3d1fe4326161d1f797b5646ab05e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcb3d1fe4326161d1f797b5646ab05e6">&#9670;&nbsp;</a></span>Clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void mxnet::Imperative::AGInfo::Clear </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;&#160;</td>
<td class="paramname"><em>node</em></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">
</div>
</div>
<a id="a01bf316282c6d229f033e9d394772293"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01bf316282c6d229f033e9d394772293">&#9670;&nbsp;</a></span>Create()</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_1_1AGInfo.html">AGInfo</a>&amp; mxnet::Imperative::AGInfo::Create </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;&#160;</td>
<td class="paramname"><em>node</em></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">
</div>
</div>
<a id="a42f1896f9cf21cfc6192b6db200ba2c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42f1896f9cf21cfc6192b6db200ba2c4">&#9670;&nbsp;</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_1_1AGInfo.html">AGInfo</a>&amp; mxnet::Imperative::AGInfo::Get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;&#160;</td>
<td class="paramname"><em>node</em></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">
</div>
</div>
<a id="afca370cc8b3e93f950d04df6e29f1fdc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afca370cc8b3e93f950d04df6e29f1fdc">&#9670;&nbsp;</a></span>IsNone()</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::AGInfo::IsNone </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> &amp;&#160;</td>
<td class="paramname"><em>arr</em></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">
</div>
</div>
<a id="a9cbce8aa6881a4cbc9ff736e3a3e7b35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cbce8aa6881a4cbc9ff736e3a3e7b35">&#9670;&nbsp;</a></span>IsVariable()</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::AGInfo::IsVariable </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;&#160;</td>
<td class="paramname"><em>node</em></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">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="afe2cb4d45bd32e40a86d2a49bfd20952"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe2cb4d45bd32e40a86d2a49bfd20952">&#9670;&nbsp;</a></span>ctx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmxnet_1_1Context.html">Context</a> mxnet::Imperative::AGInfo::ctx</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa98f7d65123fb64697769cfb952de310"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa98f7d65123fb64697769cfb952de310">&#9670;&nbsp;</a></span>fresh_out_grad</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mxnet::Imperative::AGInfo::fresh_out_grad</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad1da7fe0f83dbe5eb89770460c985a64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1da7fe0f83dbe5eb89770460c985a64">&#9670;&nbsp;</a></span>grad_req</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398">OpReqType</a> mxnet::Imperative::AGInfo::grad_req</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a694cd90f3a43ac0014fa4913da56c499"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a694cd90f3a43ac0014fa4913da56c499">&#9670;&nbsp;</a></span>out_grads</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="classmxnet_1_1NDArray.html">NDArray</a>&gt; mxnet::Imperative::AGInfo::out_grads</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2ca114d69098860adc900ba5f54c4cb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ca114d69098860adc900ba5f54c4cb5">&#9670;&nbsp;</a></span>outputs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="classmxnet_1_1NDArray.html">NDArray</a>&gt; mxnet::Imperative::AGInfo::outputs</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a027a81d4864241f12ae79388efd482da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a027a81d4864241f12ae79388efd482da">&#9670;&nbsp;</a></span>state</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::AGInfo::state</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 03:47:41 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>