blob: 8ae5aa8fc23218345eee851d1bbb9062adf549fe [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 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.13"/>
<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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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;vector&gt;</code><br />
<code>#include &lt;functional&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 name="_2work_2mxnet_23rdparty_2tvm_2nnvm_2include_2nnvm_2pass_8h" id="_2work_2mxnet_23rdparty_2tvm_2nnvm_2include_2nnvm_2pass_8h">
<area shape="rect" id="node4" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2base_8h.html" title="Configuration of nnvm as well as basic data structure. " alt="" coords="2906,408,2971,435"/>
<area shape="rect" id="node44" href="graph_8h.html" title="Configuation of nnvm as well as basic data structure. " alt="" coords="451,109,522,136"/>
<area shape="rect" id="node5" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html" title="dmlc/base.h" alt="" coords="1891,781,1992,808"/>
<area shape="rect" id="node10" href="common_8h.html" title="defines some common utility function. " alt="" coords="2649,707,2775,733"/>
<area shape="rect" id="node15" href="any_8h.html" title="Container to hold any data type. " alt="" coords="1907,632,1999,659"/>
<area shape="rect" id="node20" href="3rdparty_2dmlc-core_2include_2dmlc_2memory_8h.html" title="dmlc/memory.h" alt="" coords="3205,632,3328,659"/>
<area shape="rect" id="node24" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html" title="dmlc/registry.h" alt="" coords="2259,483,2378,509"/>
<area shape="rect" id="node42" href="array__view_8h.html" title="Read only data structure to reference array. " alt="" coords="3100,483,3241,509"/>
<area shape="rect" id="node9" href="build__config__default_8h.html" title="Default detection logic for fopen64 and other symbols. May be overriden by CMake. ..." alt="" coords="1841,856,2042,883"/>
<area shape="rect" id="node22" href="thread__local_8h.html" title="Portable thread local storage. " alt="" coords="3205,707,3328,733"/>
<area shape="rect" id="node26" href="parameter_8h.html" title="Provide lightweight util to do parameter setup and checking. " alt="" coords="1535,557,1644,584"/>
<area shape="rect" id="node38" href="type__traits_8h.html" title="type traits information header " alt="" coords="752,707,864,733"/>
<area shape="rect" id="node36" href="json_8h.html" title="Lightweight JSON Reader/Writer that read save into C++ data structs. This includes STL composites and..." alt="" coords="1661,632,1731,659"/>
<area shape="rect" id="node40" href="optional_8h.html" title="Container to hold optional data. " alt="" coords="803,632,898,659"/>
<area shape="rect" id="node41" href="strtonum_8h.html" title="A faster implementation of strtof and strtod. " alt="" coords="1891,707,1992,733"/>
<area shape="rect" id="node46" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2node_8h.html" title="Graph node data structure. " alt="" coords="539,259,605,285"/>
<area shape="rect" id="node49" href="symbolic_8h.html" title="Symbolic graph construction API. " alt="" coords="356,184,449,211"/>
<area shape="rect" id="node47" href="op_8h.html" title="Operator information structor. " alt="" coords="1715,333,1765,360"/>
<area shape="rect" id="node48" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2c__api_8h.html" title="C API of NNVM symbolic construction and pass. Enables construction and transformation of Graph in any..." alt="" coords="575,408,643,435"/>
</map>
</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 name="_2work_2mxnet_23rdparty_2tvm_2nnvm_2include_2nnvm_2pass_8hdep" id="_2work_2mxnet_23rdparty_2tvm_2nnvm_2include_2nnvm_2pass_8hdep">
<area shape="rect" id="node2" href="include_2mxnet_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="684,109,839,151"/>
<area shape="rect" id="node24" href="pass__functions_8h.html" title="Pass functions that simply redirect the calls to ApplyPass. " alt="" coords="1109,199,1294,255"/>
<area shape="rect" id="node3" href="include_2mxnet_2base_8h.html" title="/work/mxnet/include\l/mxnet/base.h" alt="" coords="644,206,799,247"/>
<area shape="rect" id="node4" href="packed__func_8h.html" title="Type&#45;erased function used across MXNET API. " alt="" coords="1270,481,1445,537"/>
<area shape="rect" id="node7" href="engine_8h.html" title="Engine that schedules all the operations according to dependency. " alt="" coords="144,303,299,344"/>
<area shape="rect" id="node8" href="include_2mxnet_2ndarray_8h.html" title="/work/mxnet/include\l/mxnet/ndarray.h" alt="" coords="701,392,856,433"/>
<area shape="rect" id="node9" href="include_2mxnet_2executor_8h.html" title="/work/mxnet/include\l/mxnet/executor.h" alt="" coords="931,675,1085,716"/>
<area shape="rect" id="node10" href="include_2mxnet_2op__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/op_attr_types.h" alt="" coords="244,489,417,530"/>
<area shape="rect" id="node11" href="include_2mxnet_2operator_8h.html" title="/work/mxnet/include\l/mxnet/operator.h" alt="" coords="472,585,627,627"/>
<area shape="rect" id="node12" href="operator__util_8h.html" title="Utility functions and registries to help quickly build new operators. [Deprecated] Use the register f..." alt="" coords="174,675,341,716"/>
<area shape="rect" id="node17" href="include_2mxnet_2io_8h.html" title="/work/mxnet/include\l/mxnet/io.h" alt="" coords="981,489,1136,530"/>
<area shape="rect" id="node19" href="resource_8h.html" title="Global resource allocation handling. " alt="" coords="347,392,501,433"/>
<area shape="rect" id="node20" href="storage_8h.html" title="Storage manager across multiple devices. " alt="" coords="701,303,856,344"/>
<area shape="rect" id="node21" href="random__generator_8h.html" title="Parallel random number generator. " alt="" coords="323,303,525,344"/>
<area shape="rect" id="node22" href="rtc_8h.html" title="/work/mxnet/include\l/mxnet/rtc.h" alt="" coords="931,303,1085,344"/>
<area shape="rect" id="node23" href="tensor__blob_8h.html" title="TBlob class that holds common representation of arbirary dimension tensor, can be used to transformed..." alt="" coords="1109,303,1269,344"/>
<area shape="rect" id="node5" href="include_2mxnet_2runtime_2registry_8h.html" title="/work/mxnet/include\l/mxnet/runtime/registry.h" alt="" coords="1265,585,1452,627"/>
<area shape="rect" id="node6" href="api__registry_8h.html" title="This file contains utilities related to the MXNet&#39;s global function registry. " alt="" coords="1279,675,1438,716"/>
<area shape="rect" id="node15" href="utils_8h.html" title="Basic utilility functions. " alt="" coords="342,764,530,805"/>
<area shape="rect" id="node14" href="imperative_8h.html" title="/work/mxnet/include\l/mxnet/imperative.h" alt="" coords="416,675,571,716"/>
<area shape="rect" id="node18" href="include_2mxnet_2kvstore_8h.html" title="/work/mxnet/include\l/mxnet/kvstore.h" alt="" coords="701,489,856,530"/>
<area shape="rect" id="node13" href="include_2mxnet_2graph__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/graph_attr_types.h" alt="" coords="203,585,397,627"/>
<area shape="rect" id="node16" href="exec__utils_8h.html" title="Common utility functions for executors. " alt="" coords="853,853,1041,895"/>
</map>
</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="#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:ac2b287a170f9c63ddccb53a7f93bb8ed"><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#ac2b287a170f9c63ddccb53a7f93bb8ed">nnvm::PassFunction</a></td></tr>
<tr class="memdesc:ac2b287a170f9c63ddccb53a7f93bb8ed"><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#ac2b287a170f9c63ddccb53a7f93bb8ed">More...</a><br /></td></tr>
<tr class="separator:ac2b287a170f9c63ddccb53a7f93bb8ed"><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 -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:43 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>