blob: 88f0c8e224dde8aee1a3c52d4d3dd3ea306d691a [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_attr_types.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="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">op_attr_types.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Data structures that can appear in operator attributes.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;functional&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;unordered_map&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="layout_8h_source.html">layout.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2node_8h_source.html">node.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2tuple_8h_source.html">tuple.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for op_attr_types.h:</div>
<div class="dyncontent">
<div class="center"><img src="3rdparty_2tvm_2nnvm_2include_2nnvm_2op__attr__types_8h__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2tvm_2nnvm_2include_2nnvm_2op__attr__types_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="3rdparty_2tvm_2nnvm_2include_2nnvm_2op__attr__types_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2tvm_2nnvm_2include_2nnvm_2op__attr__types_8hdep" alt=""/></div>
<!-- MAP 1 -->
</div>
</div>
<p><a href="3rdparty_2tvm_2nnvm_2include_2nnvm_2op__attr__types_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="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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a60262824f44e38531e7697eb1b3f4cc6"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#a60262824f44e38531e7697eb1b3f4cc6">nnvm::FListInputNames</a> = std::function&lt; std::vector&lt; std::string &gt;(const NodeAttrs &amp;attrs)&gt;</td></tr>
<tr class="memdesc:a60262824f44e38531e7697eb1b3f4cc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return list of input arguments names of each operator. <a href="namespacennvm.html#a60262824f44e38531e7697eb1b3f4cc6">More...</a><br /></td></tr>
<tr class="separator:a60262824f44e38531e7697eb1b3f4cc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87bd9af947545be600c74c00a142c7fe"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#a87bd9af947545be600c74c00a142c7fe">nnvm::FNumVisibleOutputs</a> = std::function&lt; uint32_t(const NodeAttrs &amp;attrs)&gt;</td></tr>
<tr class="memdesc:a87bd9af947545be600c74c00a142c7fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return number of visible outputs by the user. <a href="namespacennvm.html#a87bd9af947545be600c74c00a142c7fe">More...</a><br /></td></tr>
<tr class="separator:a87bd9af947545be600c74c00a142c7fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80d346f5583090eaf293fffc6028ff60"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#a80d346f5583090eaf293fffc6028ff60">nnvm::FListOutputNames</a> = std::function&lt; std::vector&lt; std::string &gt;(const NodeAttrs &amp;attrs)&gt;</td></tr>
<tr class="memdesc:a80d346f5583090eaf293fffc6028ff60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return list of output arguments names of each operator. <a href="namespacennvm.html#a80d346f5583090eaf293fffc6028ff60">More...</a><br /></td></tr>
<tr class="separator:a80d346f5583090eaf293fffc6028ff60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a8f8438feb93e69317a79594a7873b9"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#a9a8f8438feb93e69317a79594a7873b9">nnvm::FMutateInputs</a> = std::function&lt; std::vector&lt; uint32_t &gt;(const NodeAttrs &amp;attrs)&gt;</td></tr>
<tr class="memdesc:a9a8f8438feb93e69317a79594a7873b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether operator will mutate k-th input. <a href="namespacennvm.html#a9a8f8438feb93e69317a79594a7873b9">More...</a><br /></td></tr>
<tr class="separator:a9a8f8438feb93e69317a79594a7873b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e51cf5506d5c8a9a70be11fa6a9d1e1"><td class="memTemplParams" colspan="2">template&lt;typename AttrType &gt; </td></tr>
<tr class="memitem:a4e51cf5506d5c8a9a70be11fa6a9d1e1"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacennvm.html#a4e51cf5506d5c8a9a70be11fa6a9d1e1">nnvm::FInferNodeEntryAttr</a> = std::function&lt; bool(const NodeAttrs &amp;attrs, std::vector&lt; AttrType &gt; *in_attrs, std::vector&lt; AttrType &gt; *out_attrs)&gt;</td></tr>
<tr class="memdesc:a4e51cf5506d5c8a9a70be11fa6a9d1e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inference function of certain type. <a href="namespacennvm.html#a4e51cf5506d5c8a9a70be11fa6a9d1e1">More...</a><br /></td></tr>
<tr class="separator:a4e51cf5506d5c8a9a70be11fa6a9d1e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abaa4e70445e45a1fd816d16f9633a68b"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#abaa4e70445e45a1fd816d16f9633a68b">nnvm::FGetAttrDict</a> = std::function&lt; std::unordered_map&lt; std::string, std::string &gt;(const NodeAttrs &amp;attrs)&gt;</td></tr>
<tr class="memdesc:abaa4e70445e45a1fd816d16f9633a68b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get attribute dictionary from node. <a href="namespacennvm.html#abaa4e70445e45a1fd816d16f9633a68b">More...</a><br /></td></tr>
<tr class="separator:abaa4e70445e45a1fd816d16f9633a68b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae80cd6cc2432e36350ad84335d5e5308"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#ae80cd6cc2432e36350ad84335d5e5308">nnvm::FInferShape</a> = FInferNodeEntryAttr&lt; TShape &gt;</td></tr>
<tr class="memdesc:ae80cd6cc2432e36350ad84335d5e5308"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shape inference function. Update the shapes given the input shape information. <a class="el" href="classnnvm_1_1Tuple.html#abd08871f227505b80e9c1f93f3f60b1a">TShape.ndim()</a> == 0 means the shape is still unknown. <a href="namespacennvm.html#ae80cd6cc2432e36350ad84335d5e5308">More...</a><br /></td></tr>
<tr class="separator:ae80cd6cc2432e36350ad84335d5e5308"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6539f5c3067c4c3cd7dbbdd6b6a6f165"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#a6539f5c3067c4c3cd7dbbdd6b6a6f165">nnvm::FInferType</a> = FInferNodeEntryAttr&lt; int &gt;</td></tr>
<tr class="memdesc:a6539f5c3067c4c3cd7dbbdd6b6a6f165"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type inference function. Update the type given the known type information. <a href="namespacennvm.html#a6539f5c3067c4c3cd7dbbdd6b6a6f165">More...</a><br /></td></tr>
<tr class="separator:a6539f5c3067c4c3cd7dbbdd6b6a6f165"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac317e6034c26f9cb453e91cd38e35df9"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#ac317e6034c26f9cb453e91cd38e35df9">nnvm::TIsBackward</a> = bool</td></tr>
<tr class="memdesc:ac317e6034c26f9cb453e91cd38e35df9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether this op is an explicit backward operator, If TIsBackward is true: <a href="namespacennvm.html#ac317e6034c26f9cb453e91cd38e35df9">More...</a><br /></td></tr>
<tr class="separator:ac317e6034c26f9cb453e91cd38e35df9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad27d6c45aee15d0dab91419c63f8f900"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#ad27d6c45aee15d0dab91419c63f8f900">nnvm::TIsGhost</a> = bool</td></tr>
<tr class="memdesc:ad27d6c45aee15d0dab91419c63f8f900"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether this op is a ghost node. If TIsGhost is true: <a href="namespacennvm.html#ad27d6c45aee15d0dab91419c63f8f900">More...</a><br /></td></tr>
<tr class="separator:ad27d6c45aee15d0dab91419c63f8f900"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf4dd9163262b22cdac032714207e533"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#abf4dd9163262b22cdac032714207e533">nnvm::FInplaceOption</a> = std::function&lt; std::vector&lt; std::pair&lt; int, int &gt; &gt;(const NodeAttrs &amp;attrs)&gt;</td></tr>
<tr class="memdesc:abf4dd9163262b22cdac032714207e533"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get possible inplace options. This function enables optimization to reuse memory of inputs in output. <a href="namespacennvm.html#abf4dd9163262b22cdac032714207e533">More...</a><br /></td></tr>
<tr class="separator:abf4dd9163262b22cdac032714207e533"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a802f95398ea93b2bec4d239ce5b86b00"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#a802f95398ea93b2bec4d239ce5b86b00">nnvm::FInplaceIdentity</a> = std::function&lt; std::vector&lt; bool &gt;(const NodeAttrs &amp;attrs)&gt;</td></tr>
<tr class="memdesc:a802f95398ea93b2bec4d239ce5b86b00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get if the inplace option is an identity This function enables inplace optimization even when input reference count is greater than one. <a href="namespacennvm.html#a802f95398ea93b2bec4d239ce5b86b00">More...</a><br /></td></tr>
<tr class="separator:a802f95398ea93b2bec4d239ce5b86b00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af328934d094e7ff06f96b103350175f4"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#af328934d094e7ff06f96b103350175f4">nnvm::FIgnoreInputs</a> = std::function&lt; std::vector&lt; uint32_t &gt;(const NodeAttrs &amp;attrs)&gt;</td></tr>
<tr class="memdesc:af328934d094e7ff06f96b103350175f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get list of inputs in the op whose content are actually not used by the operator These are dummy input that can be used for example in zeros_like, ones_like. <a href="namespacennvm.html#af328934d094e7ff06f96b103350175f4">More...</a><br /></td></tr>
<tr class="separator:af328934d094e7ff06f96b103350175f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a68754797b1a4db29122527592915ff"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#a1a68754797b1a4db29122527592915ff">nnvm::FGradient</a> = std::function&lt; std::vector&lt; NodeEntry &gt;(const ObjectPtr &amp;nodeptr, const std::vector&lt; NodeEntry &gt; &amp;out_grads)&gt;</td></tr>
<tr class="memdesc:a1a68754797b1a4db29122527592915ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the gradient node of the op node This function generates the backward graph of the node. <a href="namespacennvm.html#a1a68754797b1a4db29122527592915ff">More...</a><br /></td></tr>
<tr class="separator:a1a68754797b1a4db29122527592915ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90a58a8b530e412ea5d6f055fa760527"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#a90a58a8b530e412ea5d6f055fa760527">nnvm::FSetInputVarAttrOnCompose</a> = std::function&lt; void(const NodeAttrs &amp;attrs, ObjectPtr var, const int index)&gt;</td></tr>
<tr class="memdesc:a90a58a8b530e412ea5d6f055fa760527"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the attributes of input variable. Usually used for setting initialization or weight decay. <a href="namespacennvm.html#a90a58a8b530e412ea5d6f055fa760527">More...</a><br /></td></tr>
<tr class="separator:a90a58a8b530e412ea5d6f055fa760527"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19b81be31144872d26056290092763a0"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#a19b81be31144872d26056290092763a0">nnvm::FCorrectLayout</a> = std::function&lt; bool(const NodeAttrs &amp;attrs, std::vector&lt; Layout &gt; *ilayouts, const std::vector&lt; Layout &gt; *last_ilayouts, std::vector&lt; Layout &gt; *olayouts)&gt;</td></tr>
<tr class="memdesc:a19b81be31144872d26056290092763a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Infer &amp; correct function of node layout. See <code><a class="el" href="classnnvm_1_1Layout.html">Layout</a></code> for layout convention. <a href="namespacennvm.html#a19b81be31144872d26056290092763a0">More...</a><br /></td></tr>
<tr class="separator:a19b81be31144872d26056290092763a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0d636002e2d607e2692cd0899c416b6"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#af0d636002e2d607e2692cd0899c416b6">nnvm::FInputGraph</a> = std::function&lt; std::vector&lt; uint32_t &gt;(const NodeAttrs &amp;attrs)&gt;</td></tr>
<tr class="memdesc:af0d636002e2d607e2692cd0899c416b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a list of inputs that represent graphs instead of data. Normally, input symbols are considered as data to the operator. However, control flow operators and high-order functions need to interpret symbols as graphs. <a href="namespacennvm.html#af0d636002e2d607e2692cd0899c416b6">More...</a><br /></td></tr>
<tr class="separator:af0d636002e2d607e2692cd0899c416b6"><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>Data structures that can appear in operator attributes. </p>
</div></div><!-- contents -->
<!-- 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>