blob: 156dd83295187fe9c2049acee2b9e9b4b878fb6b [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: /work/mxnet/3rdparty/tvm/nnvm/include/nnvm/op.h File 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="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_d40daf7ef9783ad6669561b9a39523a5.html">tvm</a></li><li class="navelem"><a class="el" href="dir_59ab2d7405f48271a817356d16f4868c.html">nnvm</a></li><li class="navelem"><a class="el" href="dir_564b1b3930cee8f0cd6786ede046ff35.html">include</a></li><li class="navelem"><a class="el" href="dir_aadb892b7c99db7e2c3fc68a6c967545.html">nnvm</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">op.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Operator information structor.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="parameter_8h_source.html">dmlc/parameter.h</a>&gt;</code><br />
<code>#include &lt;functional&gt;</code><br />
<code>#include &lt;limits&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;typeinfo&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &quot;<a class="el" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2base_8h_source.html">base.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2c__api_8h_source.html">c_api.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for op.h:</div>
<div class="dyncontent">
<div class="center"><img src="op_8h__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2tvm_2nnvm_2include_2nnvm_2op_8h" alt=""/></div>
<!-- MAP 0 -->
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="op_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2tvm_2nnvm_2include_2nnvm_2op_8hdep" alt=""/></div>
<!-- MAP 1 -->
</div>
</div>
<p><a href="op_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1OpMap.html">nnvm::OpMap&lt; ValueType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A map data structure that takes Op* as key and returns ValueType. <a href="classnnvm_1_1OpMap.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html">nnvm::Op</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator structure. <a href="classnnvm_1_1Op.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1OpMap.html">nnvm::OpMap&lt; ValueType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A map data structure that takes Op* as key and returns ValueType. <a href="classnnvm_1_1OpMap.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1OpGroup.html">nnvm::OpGroup</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">auxiliary data structure used to set attributes to a group of operators <a href="classnnvm_1_1OpGroup.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacennvm"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html">nnvm</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a88a4a87d7af6547d6879a16924cd561b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="op_8h.html#a88a4a87d7af6547d6879a16924cd561b">NNVM_REGISTER_VAR_DEF</a>(OpName)&#160;&#160;&#160;static <a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a9425a87a06019a8392509217b2a1da5a">DMLC_ATTRIBUTE_UNUSED</a> ::<a class="el" href="classnnvm_1_1Op.html">nnvm::Op</a>&amp; __make_##NnvmOp##_##OpName</td></tr>
<tr class="separator:a88a4a87d7af6547d6879a16924cd561b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2b4f84c6934f76a7084c22ae8464766"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="op_8h.html#ab2b4f84c6934f76a7084c22ae8464766">NNVM_REGISTER_GVAR_DEF</a>(TagName)&#160;&#160;&#160;static <a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a9425a87a06019a8392509217b2a1da5a">DMLC_ATTRIBUTE_UNUSED</a> ::<a class="el" href="classnnvm_1_1OpGroup.html">nnvm::OpGroup</a> __make_##NnvmOpGroup##_##TagName</td></tr>
<tr class="separator:ab2b4f84c6934f76a7084c22ae8464766"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacfc49292e41582dd1bba725ece160ae"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="op_8h.html#aacfc49292e41582dd1bba725ece160ae">NNVM_REGISTER_OP</a>(OpName)</td></tr>
<tr class="memdesc:aacfc49292e41582dd1bba725ece160ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a new operator, or set attribute of the corresponding op. <a href="op_8h.html#aacfc49292e41582dd1bba725ece160ae">More...</a><br /></td></tr>
<tr class="separator:aacfc49292e41582dd1bba725ece160ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0e87dbf2cd566db02e76ea77f14f20b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="op_8h.html#af0e87dbf2cd566db02e76ea77f14f20b">NNVM_REGISTER_OP_GROUP</a>(GroupName)&#160;&#160;&#160;<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a4feb28faa4c6af06986ecfc8eec9cd49">DMLC_STR_CONCAT</a>(<a class="el" href="op_8h.html#ab2b4f84c6934f76a7084c22ae8464766">NNVM_REGISTER_GVAR_DEF</a>(GroupName), __COUNTER__) = ::<a class="el" href="classnnvm_1_1OpGroup.html">nnvm::OpGroup</a> { #GroupName }</td></tr>
<tr class="memdesc:af0e87dbf2cd566db02e76ea77f14f20b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register attribute to a group of operators. These attributes will be registered to Op that include the group. <a href="op_8h.html#af0e87dbf2cd566db02e76ea77f14f20b">More...</a><br /></td></tr>
<tr class="separator:af0e87dbf2cd566db02e76ea77f14f20b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Operator information structor. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ab2b4f84c6934f76a7084c22ae8464766"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2b4f84c6934f76a7084c22ae8464766">&#9670;&nbsp;</a></span>NNVM_REGISTER_GVAR_DEF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NNVM_REGISTER_GVAR_DEF</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">TagName</td><td>)</td>
<td>&#160;&#160;&#160;static <a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a9425a87a06019a8392509217b2a1da5a">DMLC_ATTRIBUTE_UNUSED</a> ::<a class="el" href="classnnvm_1_1OpGroup.html">nnvm::OpGroup</a> __make_##NnvmOpGroup##_##TagName</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aacfc49292e41582dd1bba725ece160ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacfc49292e41582dd1bba725ece160ae">&#9670;&nbsp;</a></span>NNVM_REGISTER_OP</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NNVM_REGISTER_OP</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">OpName</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <a class="code" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a4feb28faa4c6af06986ecfc8eec9cd49">DMLC_STR_CONCAT</a>(<a class="code" href="op_8h.html#a88a4a87d7af6547d6879a16924cd561b">NNVM_REGISTER_VAR_DEF</a>(OpName), __COUNTER__) = <a class="code" href="classdmlc_1_1Registry.html#ae41428f0ae40e5545df63a2dd0af50d6">\</a></div>
<div class="line"><a class="code" href="classdmlc_1_1Registry.html#ae41428f0ae40e5545df63a2dd0af50d6"> ::dmlc::Registry&lt;::nnvm::Op&gt;::Get</a>()-&gt;<a class="code" href="classdmlc_1_1Registry.html#a92bb4906a07d6b41cc3b3a52cc929440">__REGISTER_OR_GET__</a>(#OpName)</div>
</div><!-- fragment -->
<p>Register a new operator, or set attribute of the corresponding op. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">OpName</td><td>The name of registry</td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"><a class="code" href="op_8h.html#aacfc49292e41582dd1bba725ece160ae">NNVM_REGISTER_OP</a>(add)</div>
<div class="line">.describe(<span class="stringliteral">&quot;add two inputs together&quot;</span>)</div>
<div class="line">.set_num_inputs(2)</div>
<div class="line">.set_attr&lt;OpKernel&gt;(<span class="stringliteral">&quot;gpu_kernel&quot;</span>, AddKernel);</div>
</div><!-- fragment -->
</div>
</div>
<a id="af0e87dbf2cd566db02e76ea77f14f20b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0e87dbf2cd566db02e76ea77f14f20b">&#9670;&nbsp;</a></span>NNVM_REGISTER_OP_GROUP</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NNVM_REGISTER_OP_GROUP</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">GroupName</td><td>)</td>
<td>&#160;&#160;&#160;<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a4feb28faa4c6af06986ecfc8eec9cd49">DMLC_STR_CONCAT</a>(<a class="el" href="op_8h.html#ab2b4f84c6934f76a7084c22ae8464766">NNVM_REGISTER_GVAR_DEF</a>(GroupName), __COUNTER__) = ::<a class="el" href="classnnvm_1_1OpGroup.html">nnvm::OpGroup</a> { #GroupName }</td>
</tr>
</table>
</div><div class="memdoc">
<p>Register attribute to a group of operators. These attributes will be registered to Op that include the group. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">GroupName</td><td>The name of the group.</td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"><a class="code" href="op_8h.html#aacfc49292e41582dd1bba725ece160ae">NNVM_REGISTER_OP</a>(add)</div>
<div class="line">.include(<span class="stringliteral">&quot;ElementwiseOpAttr&quot;</span>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// register same attributes to all the ops that include the group</span></div>
<div class="line"><a class="code" href="op_8h.html#af0e87dbf2cd566db02e76ea77f14f20b">NNVM_REGISTER_OP_GROUP</a>(ElementwiseOpAttr)</div>
<div class="line">.set_attr&lt;<a class="code" href="namespacemxnet.html#ad58e24850ee80ff4ccfe160fd1ffa6c1">FInferShape</a>&gt;(<span class="stringliteral">&quot;FInferShape&quot;</span>, ElementwiseInferShape);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="op_8h.html#aacfc49292e41582dd1bba725ece160ae">NNVM_REGISTER_OP</a>(mul)</div>
<div class="line">.include(<span class="stringliteral">&quot;ElementwiseOpAttr&quot;</span>);</div>
</div><!-- fragment -->
</div>
</div>
<a id="a88a4a87d7af6547d6879a16924cd561b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88a4a87d7af6547d6879a16924cd561b">&#9670;&nbsp;</a></span>NNVM_REGISTER_VAR_DEF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NNVM_REGISTER_VAR_DEF</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">OpName</td><td>)</td>
<td>&#160;&#160;&#160;static <a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a9425a87a06019a8392509217b2a1da5a">DMLC_ATTRIBUTE_UNUSED</a> ::<a class="el" href="classnnvm_1_1Op.html">nnvm::Op</a>&amp; __make_##NnvmOp##_##OpName</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<div class="ttc" id="aop_8h_html_a88a4a87d7af6547d6879a16924cd561b"><div class="ttname"><a href="op_8h.html#a88a4a87d7af6547d6879a16924cd561b">NNVM_REGISTER_VAR_DEF</a></div><div class="ttdeci">#define NNVM_REGISTER_VAR_DEF(OpName)</div><div class="ttdef"><b>Definition:</b> op.h:383</div></div>
<div class="ttc" id="aclassdmlc_1_1Registry_html_ae41428f0ae40e5545df63a2dd0af50d6"><div class="ttname"><a href="classdmlc_1_1Registry.html#ae41428f0ae40e5545df63a2dd0af50d6">dmlc::Registry::Get</a></div><div class="ttdeci">static Registry * Get()</div><div class="ttdoc">get a singleton of the Registry. This function can be defined by DMLC_REGISTRY_ENABLE.</div></div>
<div class="ttc" id="anamespacemxnet_html_ad58e24850ee80ff4ccfe160fd1ffa6c1"><div class="ttname"><a href="namespacemxnet.html#ad58e24850ee80ff4ccfe160fd1ffa6c1">mxnet::FInferShape</a></div><div class="ttdeci">nnvm::FInferNodeEntryAttr&lt; mxnet::TShape &gt; FInferShape</div><div class="ttdoc">Shape inference function. Update the shapes given the input shape information. TShape....</div><div class="ttdef"><b>Definition:</b> tuple.h:842</div></div>
<div class="ttc" id="aclassdmlc_1_1Registry_html_a92bb4906a07d6b41cc3b3a52cc929440"><div class="ttname"><a href="classdmlc_1_1Registry.html#a92bb4906a07d6b41cc3b3a52cc929440">dmlc::Registry::__REGISTER_OR_GET__</a></div><div class="ttdeci">EntryType &amp; __REGISTER_OR_GET__(const std::string &amp;name)</div><div class="ttdoc">Internal function to either register or get registered entry.</div><div class="ttdef"><b>Definition:</b> registry.h:95</div></div>
<div class="ttc" id="a3rdparty_2dmlc-core_2include_2dmlc_2base_8h_html_a4feb28faa4c6af06986ecfc8eec9cd49"><div class="ttname"><a href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a4feb28faa4c6af06986ecfc8eec9cd49">DMLC_STR_CONCAT</a></div><div class="ttdeci">#define DMLC_STR_CONCAT(__x, __y)</div><div class="ttdef"><b>Definition:</b> base.h:162</div></div>
<div class="ttc" id="aop_8h_html_af0e87dbf2cd566db02e76ea77f14f20b"><div class="ttname"><a href="op_8h.html#af0e87dbf2cd566db02e76ea77f14f20b">NNVM_REGISTER_OP_GROUP</a></div><div class="ttdeci">#define NNVM_REGISTER_OP_GROUP(GroupName)</div><div class="ttdoc">Register attribute to a group of operators. These attributes will be registered to Op that include th...</div><div class="ttdef"><b>Definition:</b> op.h:429</div></div>
<div class="ttc" id="aop_8h_html_aacfc49292e41582dd1bba725ece160ae"><div class="ttname"><a href="op_8h.html#aacfc49292e41582dd1bba725ece160ae">NNVM_REGISTER_OP</a></div><div class="ttdeci">#define NNVM_REGISTER_OP(OpName)</div><div class="ttdoc">Register a new operator, or set attribute of the corresponding op.</div><div class="ttdef"><b>Definition:</b> op.h:404</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:40 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>