Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / master / api / cpp / docs / api / pass_8h.html
blob: c860983306ef58272585cb5fd91dbdf22fc8afff [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/pass.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> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">pass.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Pass that can be applied to a graph.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;functional&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="graph_8h_source.html">graph.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for pass.h:</div>
<div class="dyncontent">
<div class="center"><img src="pass_8h__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2tvm_2nnvm_2include_2nnvm_2pass_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="pass_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2tvm_2nnvm_2include_2nnvm_2pass_8hdep" alt=""/></div>
<!-- MAP 1 -->
</div>
</div>
<p><a href="pass_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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnnvm_1_1PassFunctionReg.html">nnvm::PassFunctionReg</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registry entry for pass functions. <a href="structnnvm_1_1PassFunctionReg.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:a1e71a68c992d437f9d874ff57fbf2d7e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pass_8h.html#a1e71a68c992d437f9d874ff57fbf2d7e">NNVM_REGISTER_PASS</a>(name)&#160;&#160;&#160;<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html#af6870c3bce5b56d427a4d225b1194816">DMLC_REGISTRY_REGISTER</a>(::<a class="el" href="structnnvm_1_1PassFunctionReg.html">nnvm::PassFunctionReg</a>, PassFunctionReg, name)</td></tr>
<tr class="memdesc:a1e71a68c992d437f9d874ff57fbf2d7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro to register pass fuctions. <a href="pass_8h.html#a1e71a68c992d437f9d874ff57fbf2d7e">More...</a><br /></td></tr>
<tr class="separator:a1e71a68c992d437f9d874ff57fbf2d7e"><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:a3bf9c138f25560f6c86dcc726d6b9125"><td class="memItemLeft" align="right" valign="top">typedef std::function&lt; Graph(Graph src)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#a3bf9c138f25560f6c86dcc726d6b9125">nnvm::PassFunction</a></td></tr>
<tr class="memdesc:a3bf9c138f25560f6c86dcc726d6b9125"><td class="mdescLeft">&#160;</td><td class="mdescRight">A PassFunction is an "Operator on Graph". It takes a source graph and return a graph that may or may not be the same as the input one. <a href="namespacennvm.html#a3bf9c138f25560f6c86dcc726d6b9125">More...</a><br /></td></tr>
<tr class="separator:a3bf9c138f25560f6c86dcc726d6b9125"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a36b92fb36f36675e96255310f3450662"><td class="memItemLeft" align="right" valign="top">Graph&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#a36b92fb36f36675e96255310f3450662">nnvm::ApplyPasses</a> (Graph src, const std::vector&lt; std::string &gt; &amp;passes)</td></tr>
<tr class="memdesc:a36b92fb36f36675e96255310f3450662"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply a series of pass transformations on the input graph. <a href="namespacennvm.html#a36b92fb36f36675e96255310f3450662">More...</a><br /></td></tr>
<tr class="separator:a36b92fb36f36675e96255310f3450662"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9e352fbb58722c23de790c9cfafdfd7"><td class="memItemLeft" align="right" valign="top">Graph&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacennvm.html#af9e352fbb58722c23de790c9cfafdfd7">nnvm::ApplyPass</a> (Graph src, const std::string &amp;pass)</td></tr>
<tr class="memdesc:af9e352fbb58722c23de790c9cfafdfd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply one pass to the graph. <a href="namespacennvm.html#af9e352fbb58722c23de790c9cfafdfd7">More...</a><br /></td></tr>
<tr class="separator:af9e352fbb58722c23de790c9cfafdfd7"><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>Pass that can be applied to a graph. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a1e71a68c992d437f9d874ff57fbf2d7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e71a68c992d437f9d874ff57fbf2d7e">&#9670;&nbsp;</a></span>NNVM_REGISTER_PASS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NNVM_REGISTER_PASS</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">name</td><td>)</td>
<td>&#160;&#160;&#160;<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html#af6870c3bce5b56d427a4d225b1194816">DMLC_REGISTRY_REGISTER</a>(::<a class="el" href="structnnvm_1_1PassFunctionReg.html">nnvm::PassFunctionReg</a>, PassFunctionReg, name)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Macro to register pass fuctions. </p>
<div class="fragment"><div class="line"><span class="comment">// example of registering a shape inference pass</span></div>
<div class="line"><a class="code" href="pass_8h.html#a1e71a68c992d437f9d874ff57fbf2d7e">NNVM_REGISTER_PASS</a>(<a class="code" href="namespacennvm_1_1pass.html#a9fd9e840e169150d3cb4439448fd1561">InferShape</a>)</div>
<div class="line">.describe(<span class="stringliteral">&quot;Shape Inference function, generate graph attributes&quot;</span>)</div>
<div class="line">.provide_graph_attr(<span class="stringliteral">&quot;data_shape&quot;</span>)</div>
<div class="line">.depend_graph_attr(<span class="stringliteral">&quot;indexed_graph&quot;</span>)</div>
<div class="line">.depend_op_attr(<span class="stringliteral">&quot;infer_shape&quot;</span>)</div>
<div class="line">.set_body([](<span class="keyword">const</span> Graph&amp; g) {</div>
<div class="line"> <span class="comment">// shape inference logic</span></div>
<div class="line"> });</div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<div class="ttc" id="apass_8h_html_a1e71a68c992d437f9d874ff57fbf2d7e"><div class="ttname"><a href="pass_8h.html#a1e71a68c992d437f9d874ff57fbf2d7e">NNVM_REGISTER_PASS</a></div><div class="ttdeci">#define NNVM_REGISTER_PASS(name)</div><div class="ttdoc">Macro to register pass fuctions.</div><div class="ttdef"><b>Definition:</b> pass.h:136</div></div>
<div class="ttc" id="anamespacennvm_1_1pass_html_a9fd9e840e169150d3cb4439448fd1561"><div class="ttname"><a href="namespacennvm_1_1pass.html#a9fd9e840e169150d3cb4439448fd1561">nnvm::pass::InferShape</a></div><div class="ttdeci">Graph InferShape(Graph graph, ShapeVector shape_inputs, std::string shape_attr_key=&quot;&quot;)</div><div class="ttdoc">Infer shapes in the graph given the information.</div><div class="ttdef"><b>Definition:</b> pass_functions.h:95</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>