blob: dec0d562f9d2ccbacc276c5c759f64fb59df7130 [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/include/mxnet/api_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.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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">api_registry.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This file contains utilities related to the MXNet's global function registry.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;string&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &quot;<a class="el" href="include_2mxnet_2runtime_2registry_8h_source.html">runtime/registry.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for api_registry.h:</div>
<div class="dyncontent">
<div class="center"><img src="api__registry_8h__incl.png" border="0" usemap="#_2work_2mxnet_2include_2mxnet_2api__registry_8h" alt=""/></div>
<map name="_2work_2mxnet_2include_2mxnet_2api__registry_8h" id="_2work_2mxnet_2include_2mxnet_2api__registry_8h">
<area shape="rect" id="node4" href="include_2mxnet_2runtime_2registry_8h.html" title="runtime/registry.h" alt="" coords="43,95,181,121"/>
<area shape="rect" id="node6" href="packed__func_8h.html" title="Type&#45;erased function used across MXNET API. " alt="" coords="2825,169,2941,196"/>
<area shape="rect" id="node8" href="c__runtime__api_8h.html" title="mxnet/runtime/c_runtime\l_api.h" alt="" coords="3698,931,3886,972"/>
<area shape="rect" id="node14" href="object_8h.html" title="A managed object in MXNet runtime. " alt="" coords="3629,849,3803,875"/>
<area shape="rect" id="node17" href="include_2mxnet_2runtime_2ndarray_8h.html" title="A device&#45;independent managed NDArray abstraction. " alt="" coords="3101,244,3283,271"/>
<area shape="rect" id="node18" href="runtime_2container_8h.html" title="mxnet/runtime/container.h" alt="" coords="3455,692,3649,719"/>
<area shape="rect" id="node22" href="ffi__helper_8h.html" title="mxnet/runtime/ffi_helper.h" alt="" coords="3275,617,3469,644"/>
<area shape="rect" id="node24" href="data__type_8h.html" title="mxnet/runtime/data\l_type.h" alt="" coords="3996,841,4148,883"/>
<area shape="rect" id="node25" href="node_2container_8h.html" title="mxnet/node/container.h" alt="" coords="2795,617,2971,644"/>
<area shape="rect" id="node28" href="expr_8h.html" title="Base expr nodes in MXNet. " alt="" coords="2985,543,3106,569"/>
<area shape="rect" id="node29" href="include_2mxnet_2ndarray_8h.html" title="mxnet/ndarray.h" alt="" coords="1719,244,1847,271"/>
<area shape="rect" id="node43" href="include_2mxnet_2base_8h.html" title="./base.h" alt="" coords="1410,393,1483,420"/>
<area shape="rect" id="node9" href="dlpack_8h.html" title="The common header of DLPack. " alt="" coords="3730,1020,3854,1047"/>
<area shape="rect" id="node12" href="include_2mxnet_2c__api_8h.html" title="mxnet/c_api.h" alt="" coords="3540,1020,3655,1047"/>
<area shape="rect" id="node19" href="include_2mxnet_2runtime_2memory_8h.html" title="Runtime memory management. " alt="" coords="3089,767,3277,793"/>
<area shape="rect" id="node26" href="include_2mxnet_2node_2node_8h.html" title="mxnet/node/node.h" alt="" coords="2971,692,3119,719"/>
<area shape="rect" id="node30" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html" title="dmlc/base.h" alt="" coords="1497,849,1599,875"/>
<area shape="rect" id="node32" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h.html" title="dmlc/io.h" alt="" coords="595,468,677,495"/>
<area shape="rect" id="node33" href="type__traits_8h.html" title="type traits information header " alt="" coords="1485,767,1597,793"/>
<area shape="rect" id="node34" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html" title="dmlc/registry.h" alt="" coords="923,617,1042,644"/>
<area shape="rect" id="node39" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2node_8h.html" title="Graph node data structure. " alt="" coords="1848,543,1955,569"/>
<area shape="rect" id="node49" href="storage_8h.html" title="Storage manager across multiple devices. " alt="" coords="1737,319,1828,345"/>
<area shape="rect" id="node50" href="engine_8h.html" title="Engine that schedules all the operations according to dependency. " alt="" coords="1214,319,1301,345"/>
<area shape="rect" id="node36" href="parameter_8h.html" title="Provide lightweight util to do parameter setup and checking. " alt="" coords="1168,692,1277,719"/>
<area shape="rect" id="node41" href="op_8h.html" title="Operator information structor. " alt="" coords="1339,617,1389,644"/>
<area shape="rect" id="node44" href="tensor_8h.html" title="header file of tensor data structure and functions This lib requires explicit memory allocation and d..." alt="" coords="823,468,964,495"/>
<area shape="rect" id="node45" href="symbolic_8h.html" title="Symbolic graph construction API. " alt="" coords="1693,468,1827,495"/>
<area shape="rect" id="node47" href="libinfo_8h.html" title="get features of the MXNet library at runtime " alt="" coords="1588,543,1663,569"/>
<area shape="rect" id="node48" href="include_2mxnet_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="2647,468,2713,495"/>
</map>
</div>
</div>
<p><a href="api__registry_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: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>
</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:a7ecf4af4ccf3a3e05e7276d96dec70ca"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__registry_8h.html#a7ecf4af4ccf3a3e05e7276d96dec70ca">MXNET_REGISTER_API</a>(OpName)&#160;&#160;&#160;<a class="el" href="include_2mxnet_2runtime_2registry_8h.html#a47b953eb63d70c34c3c915ce55b04200">MXNET_REGISTER_GLOBAL</a>(OpName)</td></tr>
<tr class="memdesc:a7ecf4af4ccf3a3e05e7276d96dec70ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register an API function globally. It simply redirects to MXNET_REGISTER_GLOBAL. <a href="#a7ecf4af4ccf3a3e05e7276d96dec70ca">More...</a><br /></td></tr>
<tr class="separator:a7ecf4af4ccf3a3e05e7276d96dec70ca"><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 contains utilities related to the MXNet's global function registry. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a7ecf4af4ccf3a3e05e7276d96dec70ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ecf4af4ccf3a3e05e7276d96dec70ca">&#9670;&nbsp;</a></span>MXNET_REGISTER_API</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MXNET_REGISTER_API</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">OpName</td><td>)</td>
<td>&#160;&#160;&#160;<a class="el" href="include_2mxnet_2runtime_2registry_8h.html#a47b953eb63d70c34c3c915ce55b04200">MXNET_REGISTER_GLOBAL</a>(OpName)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Register an API function globally. It simply redirects to MXNET_REGISTER_GLOBAL. </p>
<div class="fragment"><div class="line"><a class="code" href="api__registry_8h.html#a7ecf4af4ccf3a3e05e7276d96dec70ca">MXNET_REGISTER_API</a>(MyPrint)</div><div class="line">.set_body([](MXNetArgs args, MXNetRetValue* rv) {</div><div class="line"> <span class="comment">// my code.</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>