Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / api / cpp / docs / api / include_2mxnet_2runtime_2registry_8h.html
blob: 17c3c20fe0a4284949a10342515d59e6f527c1cf [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/include/mxnet/runtime/registry.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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li><li class="navelem"><a class="el" href="dir_8e7a93613ef4c7e7d673effa691c1739.html">runtime</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">registry.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This file defines the TVM global function registry.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;string&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &quot;<a class="el" href="packed__func_8h_source.html">packed_func.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for registry.h:</div>
<div class="dyncontent">
<div class="center"><img src="include_2mxnet_2runtime_2registry_8h__incl.png" border="0" usemap="#_2work_2mxnet_2include_2mxnet_2runtime_2registry_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="include_2mxnet_2runtime_2registry_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_2include_2mxnet_2runtime_2registry_8hdep" alt=""/></div>
<!-- MAP 1 -->
</div>
</div>
<p><a href="include_2mxnet_2runtime_2registry_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="classmxnet_1_1runtime_1_1Registry.html">mxnet::runtime::Registry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html" title="Registry for global function.">Registry</a> for global function. <a href="classmxnet_1_1runtime_1_1Registry.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:namespacemxnet"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html">mxnet</a></td></tr>
<tr class="memdesc:namespacemxnet"><td class="mdescLeft">&#160;</td><td class="mdescRight">namespace of mxnet <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacemxnet_1_1runtime"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1runtime.html">mxnet::runtime</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:abada2ca2f66e644594d379e84b7d02da"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2mxnet_2runtime_2registry_8h.html#abada2ca2f66e644594d379e84b7d02da">MXNET_ATTRIBUTE_UNUSED</a></td></tr>
<tr class="memdesc:abada2ca2f66e644594d379e84b7d02da"><td class="mdescLeft">&#160;</td><td class="mdescRight">helper macro to supress unused warning <a href="include_2mxnet_2runtime_2registry_8h.html#abada2ca2f66e644594d379e84b7d02da">More...</a><br /></td></tr>
<tr class="separator:abada2ca2f66e644594d379e84b7d02da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36886e1882616d888df42d20f7e4b680"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2mxnet_2runtime_2registry_8h.html#a36886e1882616d888df42d20f7e4b680">MXNET_STR_CONCAT_</a>(__x, __y)&#160;&#160;&#160;__x##__y</td></tr>
<tr class="separator:a36886e1882616d888df42d20f7e4b680"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad53b1fecb0394c8809d6dbe4e13d31bc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2mxnet_2runtime_2registry_8h.html#ad53b1fecb0394c8809d6dbe4e13d31bc">MXNET_STR_CONCAT</a>(__x, __y)&#160;&#160;&#160;<a class="el" href="include_2mxnet_2runtime_2registry_8h.html#a36886e1882616d888df42d20f7e4b680">MXNET_STR_CONCAT_</a>(__x, __y)</td></tr>
<tr class="separator:ad53b1fecb0394c8809d6dbe4e13d31bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49b72f63a104628ec33c966bc40bce00"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2mxnet_2runtime_2registry_8h.html#a49b72f63a104628ec33c966bc40bce00">MXNET_FUNC_REG_VAR_DEF</a>&#160;&#160;&#160;static <a class="el" href="include_2mxnet_2runtime_2registry_8h.html#abada2ca2f66e644594d379e84b7d02da">MXNET_ATTRIBUTE_UNUSED</a> ::<a class="el" href="classmxnet_1_1runtime_1_1Registry.html">mxnet::runtime::Registry</a>&amp; __mk_##MXNET</td></tr>
<tr class="separator:a49b72f63a104628ec33c966bc40bce00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47b953eb63d70c34c3c915ce55b04200"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2mxnet_2runtime_2registry_8h.html#a47b953eb63d70c34c3c915ce55b04200">MXNET_REGISTER_GLOBAL</a>(OpName)</td></tr>
<tr class="memdesc:a47b953eb63d70c34c3c915ce55b04200"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a function globally. <a href="include_2mxnet_2runtime_2registry_8h.html#a47b953eb63d70c34c3c915ce55b04200">More...</a><br /></td></tr>
<tr class="separator:a47b953eb63d70c34c3c915ce55b04200"><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>This file defines the TVM global function registry. </p>
<p>The registered functions will be made available to front-end as well as backend users.</p>
<p>The registry stores type-erased functions. Each registered function is automatically exposed to front-end language(e.g. python).</p>
<p>Front-end can also pass callbacks as PackedFunc, or register then into the same global registry in C++. The goal is to mix the front-end language and the TVM back-end.</p>
<div class="fragment"><div class="line"><span class="comment">// register the function as MyAPIFuncName</span></div>
<div class="line">TVM_REGISTER_GLOBAL(MyAPIFuncName)</div>
<div class="line">.set_body([](TVMArgs args, TVMRetValue* rv) {</div>
<div class="line"> <span class="comment">// my code.</span></div>
<div class="line">});</div>
</div><!-- fragment --> </div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="abada2ca2f66e644594d379e84b7d02da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abada2ca2f66e644594d379e84b7d02da">&#9670;&nbsp;</a></span>MXNET_ATTRIBUTE_UNUSED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MXNET_ATTRIBUTE_UNUSED</td>
</tr>
</table>
</div><div class="memdoc">
<p>helper macro to supress unused warning </p>
</div>
</div>
<a id="a49b72f63a104628ec33c966bc40bce00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49b72f63a104628ec33c966bc40bce00">&#9670;&nbsp;</a></span>MXNET_FUNC_REG_VAR_DEF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MXNET_FUNC_REG_VAR_DEF&#160;&#160;&#160;static <a class="el" href="include_2mxnet_2runtime_2registry_8h.html#abada2ca2f66e644594d379e84b7d02da">MXNET_ATTRIBUTE_UNUSED</a> ::<a class="el" href="classmxnet_1_1runtime_1_1Registry.html">mxnet::runtime::Registry</a>&amp; __mk_##MXNET</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a47b953eb63d70c34c3c915ce55b04200"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47b953eb63d70c34c3c915ce55b04200">&#9670;&nbsp;</a></span>MXNET_REGISTER_GLOBAL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MXNET_REGISTER_GLOBAL</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="include_2mxnet_2runtime_2registry_8h.html#ad53b1fecb0394c8809d6dbe4e13d31bc">MXNET_STR_CONCAT</a>(<a class="code" href="include_2mxnet_2runtime_2registry_8h.html#a49b72f63a104628ec33c966bc40bce00">MXNET_FUNC_REG_VAR_DEF</a>, __COUNTER__) = <a class="code" href="classmxnet_1_1runtime_1_1Registry.html#a1d574df0edaa072df58a09f6788e72ac">\</a></div>
<div class="line"><a class="code" href="classmxnet_1_1runtime_1_1Registry.html#a1d574df0edaa072df58a09f6788e72ac"> ::mxnet::runtime::Registry::Register</a>(OpName)</div>
</div><!-- fragment -->
<p>Register a function globally. </p>
<div class="fragment"><div class="line">TVM_REGISTER_GLOBAL(<span class="stringliteral">&quot;MyPrint&quot;</span>)</div>
<div class="line">.set_body([](TVMArgs args, TVMRetValue* rv) {</div>
<div class="line">});</div>
</div><!-- fragment -->
</div>
</div>
<a id="ad53b1fecb0394c8809d6dbe4e13d31bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad53b1fecb0394c8809d6dbe4e13d31bc">&#9670;&nbsp;</a></span>MXNET_STR_CONCAT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MXNET_STR_CONCAT</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">__x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">__y&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;<a class="el" href="include_2mxnet_2runtime_2registry_8h.html#a36886e1882616d888df42d20f7e4b680">MXNET_STR_CONCAT_</a>(__x, __y)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a36886e1882616d888df42d20f7e4b680"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36886e1882616d888df42d20f7e4b680">&#9670;&nbsp;</a></span>MXNET_STR_CONCAT_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MXNET_STR_CONCAT_</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">__x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">__y&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;__x##__y</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<div class="ttc" id="ainclude_2mxnet_2runtime_2registry_8h_html_a49b72f63a104628ec33c966bc40bce00"><div class="ttname"><a href="include_2mxnet_2runtime_2registry_8h.html#a49b72f63a104628ec33c966bc40bce00">MXNET_FUNC_REG_VAR_DEF</a></div><div class="ttdeci">#define MXNET_FUNC_REG_VAR_DEF</div><div class="ttdef"><b>Definition:</b> registry.h:308</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1Registry_html_a1d574df0edaa072df58a09f6788e72ac"><div class="ttname"><a href="classmxnet_1_1runtime_1_1Registry.html#a1d574df0edaa072df58a09f6788e72ac">mxnet::runtime::Registry::Register</a></div><div class="ttdeci">static MXNET_DLL Registry &amp; Register(const std::string &amp;name, bool override=false)</div><div class="ttdoc">Register a function with given name.</div></div>
<div class="ttc" id="ainclude_2mxnet_2runtime_2registry_8h_html_ad53b1fecb0394c8809d6dbe4e13d31bc"><div class="ttname"><a href="include_2mxnet_2runtime_2registry_8h.html#ad53b1fecb0394c8809d6dbe4e13d31bc">MXNET_STR_CONCAT</a></div><div class="ttdeci">#define MXNET_STR_CONCAT(__x, __y)</div><div class="ttdef"><b>Definition:</b> registry.h:306</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>