| <!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 content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/> |
| <meta content="IE=9" http-equiv="X-UA-Compatible"/> |
| <meta content="Doxygen 1.8.6" name="generator"/> |
| <title>mxnet: include/mxnet/operator.h File Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script src="jquery.js" type="text/javascript"></script> |
| <script src="dynsections.js" type="text/javascript"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script src="search/search.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </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 cellpadding="0" cellspacing="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.6 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div class="tabs" id="navrow1"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div class="MSearchBoxInactive" id="MSearchBox"> |
| <span class="left"> |
| <img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/> |
| <input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/> |
| </span><span class="right"> |
| <a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="tabs2" id="navrow2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></div> |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)"> |
| </iframe> |
| </div> |
| <div class="navpath" id="nav-path"> |
| <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="#nested-classes">Classes</a> | |
| <a href="#namespaces">Namespaces</a> | |
| <a href="#define-members">Macros</a> | |
| <a href="#typedef-members">Typedefs</a> </div> |
| <div class="headertitle"> |
| <div class="title">operator.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <p>Operator interface of mxnet. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include <dmlc/base.h></code><br/> |
| <code>#include <dmlc/json.h></code><br/> |
| <code>#include <dmlc/logging.h></code><br/> |
| <code>#include <dmlc/registry.h></code><br/> |
| <code>#include <nnvm/node.h></code><br/> |
| <code>#include <vector></code><br/> |
| <code>#include <map></code><br/> |
| <code>#include <string></code><br/> |
| <code>#include <utility></code><br/> |
| <code>#include "<a class="el" href="base_8h_source.html">./base.h</a>"</code><br/> |
| <code>#include "<a class="el" href="resource_8h_source.html">./resource.h</a>"</code><br/> |
| <code>#include "<a class="el" href="op__attr__types_8h_source.html">./op_attr_types.h</a>"</code><br/> |
| </div><div class="textblock"><div class="dynheader"> |
| Include dependency graph for operator.h:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="" border="0" src="operator_8h__incl.png" usemap="#include_2mxnet_2operator_8h"/></div> |
| <map id="include_2mxnet_2operator_8h" name="include_2mxnet_2operator_8h"> |
| <area alt="" coords="1151,320,1220,347" href="base_8h.html" id="node11" shape="rect" title="configuration of MXNet as well as basic data structure. "/><area alt="" coords="492,155,583,181" href="resource_8h.html" id="node19" shape="rect" title="Global resource allocation handling. "/><area alt="" coords="1359,80,1479,107" href="op__attr__types_8h.html" id="node34" shape="rect" title="Additional operator attributes beside the ones provided by NNVM. "/><area alt="" coords="1542,237,1620,264" href="engine_8h.html" id="node20" shape="rect" title="Engine that schedules all the operations according to dependency. "/><area alt="" coords="411,230,575,271" href="random__generator_8h.html" id="node24" shape="rect" title="Parallel random number generator. "/><area alt="" coords="235,320,393,347" href="cuda__utils_8h.html" id="node28" shape="rect" title="CUDA debugging utilities. "/><area alt="" coords="1230,155,1313,181" href="ndarray_8h.html" id="node36" shape="rect" title="NDArray interface that handles array arithematics. "/><area alt="" coords="1179,237,1263,264" href="storage_8h.html" id="node37" shape="rect" title="Storage manager across multiple devices. "/></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 alt="" border="0" src="operator_8h__dep__incl.png" usemap="#include_2mxnet_2operator_8hdep"/></div> |
| <map id="include_2mxnet_2operator_8hdep" name="include_2mxnet_2operator_8hdep"> |
| <area alt="" coords="5,88,173,115" href="executor_8h.html" id="node2" shape="rect" title="Symbolic executor interface of mxnet. "/><area alt="" coords="197,81,351,122" href="operator__util_8h.html" id="node3" shape="rect" title="Utility functions and registries to help quickly build new operators. [Deprecated] Use the register f..."/></map> |
| </div> |
| </div> |
| <p><a href="operator_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 align="right" class="memItemLeft" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Operator.html">mxnet::Operator</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmxnet_1_1Operator.html" title="Operator interface. Operator defines basic operation unit of optimized computation graph in mxnet...">Operator</a> interface. <a class="el" href="classmxnet_1_1Operator.html" title="Operator interface. Operator defines basic operation unit of optimized computation graph in mxnet...">Operator</a> defines basic operation unit of optimized computation graph in mxnet. This interface relies on pre-allocated memory in <a class="el" href="classmxnet_1_1TBlob.html" title="tensor blob class that can be used to hold tensor of any dimension, any device and any data type...">TBlob</a>, the caller need to set the memory region in <a class="el" href="classmxnet_1_1TBlob.html" title="tensor blob class that can be used to hold tensor of any dimension, any device and any data type...">TBlob</a> correctly before calling Forward and Backward. <a href="classmxnet_1_1Operator.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1OperatorProperty.html">mxnet::OperatorProperty</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmxnet_1_1OperatorProperty.html" title="OperatorProperty is a object that stores all information about Operator. It also contains method to g...">OperatorProperty</a> is a object that stores all information about <a class="el" href="classmxnet_1_1Operator.html" title="Operator interface. Operator defines basic operation unit of optimized computation graph in mxnet...">Operator</a>. It also contains method to generate context(device) specific operators. <a href="classmxnet_1_1OperatorProperty.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1OperatorPropertyReg.html">mxnet::OperatorPropertyReg</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Registry entry for <a class="el" href="classmxnet_1_1OperatorProperty.html" title="OperatorProperty is a object that stores all information about Operator. It also contains method to g...">OperatorProperty</a> factory functions. <a href="structmxnet_1_1OperatorPropertyReg.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </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 align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html">mxnet</a></td></tr> |
| <tr class="memdesc:namespacemxnet"><td class="mdescLeft"> </td><td class="mdescRight">namespace of mxnet <br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </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:a926db042759256e94d20696c66f65709"><td align="right" class="memItemLeft" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="operator_8h.html#a926db042759256e94d20696c66f65709">MXNET_REGISTER_OP_PROPERTY</a>(name, OperatorPropertyType)</td></tr> |
| <tr class="memdesc:a926db042759256e94d20696c66f65709"><td class="mdescLeft"> </td><td class="mdescRight">Macro to register OperatorProperty. <a href="#a926db042759256e94d20696c66f65709">More...</a><br/></td></tr> |
| <tr class="separator:a926db042759256e94d20696c66f65709"><td class="memSeparator" colspan="2"> </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:a6f5428fbf261a94eaac079ec24413815"><td align="right" class="memItemLeft" valign="top">typedef std::function<br class="typebreak"/> |
| < OperatorProperty *()> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#a6f5428fbf261a94eaac079ec24413815">mxnet::OperatorPropertyFactory</a></td></tr> |
| <tr class="memdesc:a6f5428fbf261a94eaac079ec24413815"><td class="mdescLeft"> </td><td class="mdescRight">typedef the factory function of operator property <a href="#a6f5428fbf261a94eaac079ec24413815">More...</a><br/></td></tr> |
| <tr class="separator:a6f5428fbf261a94eaac079ec24413815"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Operator interface of mxnet. </p> |
| <p>Copyright (c) 2015 by Contributors</p> |
| <dl class="section author"><dt>Author</dt><dd>Naiyan Wang </dd></dl> |
| </div><h2 class="groupheader">Macro Definition Documentation</h2> |
| <a class="anchor" id="a926db042759256e94d20696c66f65709"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define MXNET_REGISTER_OP_PROPERTY</td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname">name, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname">OperatorPropertyType </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <b>Value:</b><div class="fragment"><div class="line">DMLC_REGISTRY_REGISTER(::<a class="code" href="structmxnet_1_1OperatorPropertyReg.html">mxnet::OperatorPropertyReg</a>, OperatorPropertyReg, name) \</div> |
| <div class="line"> .set_body([]() { <span class="keywordflow">return</span> <span class="keyword">new</span> OperatorPropertyType(); }) \</div> |
| <div class="line"> .set_return_type(<span class="stringliteral">"NDArray-or-Symbol"</span>) \</div> |
| <div class="line"> .check_name()</div> |
| <div class="ttc" id="structmxnet_1_1OperatorPropertyReg_html"><div class="ttname"><a href="structmxnet_1_1OperatorPropertyReg.html">mxnet::OperatorPropertyReg</a></div><div class="ttdoc">Registry entry for OperatorProperty factory functions. </div><div class="ttdef"><b>Definition:</b> operator.h:453</div></div> |
| </div><!-- fragment --> |
| <p>Macro to register OperatorProperty. </p> |
| <div class="fragment"><div class="line"><span class="comment">// example of registering a fully connected operator</span></div> |
| <div class="line">REGISTER_OP_PROPERTY(FullyConnected, FullyConnectedOpProp)</div> |
| <div class="line">.describe(<span class="stringliteral">"Fully connected layer"</span>);</div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Sat Feb 24 2018 07:03:22 for mxnet by <a href="http://www.doxygen.org/index.html"> |
| <img alt="doxygen" class="footer" src="doxygen.png"/> |
| </a> 1.8.6 |
| </small></address> |
| </body> |
| </html> |