| <!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.11" name="generator"/> |
| <title>mxnet: include/mxnet/operator_util.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/searchdata.js" type="text/javascript"></script> |
| <script src="search/search.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { init_search(); }); |
| </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 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.11 --> |
| <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()"> |
| </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> | |
| <a href="#enum-members">Enumerations</a> </div> |
| <div class="headertitle"> |
| <div class="title">operator_util.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <p>Utility functions and registries to help quickly build new operators. [Deprecated] Use the register functions in this file when possible to simplify operator creations. Operators registered in this file will be exposed to both NDArray API and symbolic API. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include <dmlc/registry.h></code><br/> |
| <code>#include <dmlc/parameter.h></code><br/> |
| <code>#include <map></code><br/> |
| <code>#include <vector></code><br/> |
| <code>#include <string></code><br/> |
| <code>#include <utility></code><br/> |
| <code>#include "<a class="el" href="include_2mxnet_2base_8h_source.html">./base.h</a>"</code><br/> |
| <code>#include "<a class="el" href="include_2mxnet_2operator_8h_source.html">./operator.h</a>"</code><br/> |
| <code>#include <functional></code><br/> |
| </div><div class="textblock"><div class="dynheader"> |
| Include dependency graph for operator_util.h:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="" border="0" src="operator__util_8h__incl.png" usemap="#include_2mxnet_2operator__util_8h"/></div> |
| <map id="include_2mxnet_2operator__util_8h" name="include_2mxnet_2operator__util_8h"> |
| <area alt="" coords="1165,408,1238,435" href="include_2mxnet_2base_8h.html" id="node8" shape="rect" title="./base.h"/> |
| <area alt="" coords="1524,95,1620,121" href="include_2mxnet_2operator_8h.html" id="node16" shape="rect" title="./operator.h"/> |
| <area alt="" coords="857,244,956,271" href="resource_8h.html" id="node20" shape="rect" title="Global resource allocation handling. "/> |
| <area alt="" coords="1507,169,1637,196" href="op__attr__types_8h.html" id="node35" shape="rect" title="Additional operator attributes beside the ones provided by NNVM. "/> |
| <area alt="" coords="1529,326,1615,353" href="engine_8h.html" id="node21" shape="rect" title="Engine that schedules all the operations according to dependency. "/> |
| <area alt="" coords="674,319,854,360" href="random__generator_8h.html" id="node25" shape="rect" title="Parallel random number generator. "/> |
| <area alt="" coords="405,408,576,435" href="cuda__utils_8h.html" id="node29" shape="rect" title="CUDA debugging utilities. "/> |
| <area alt="" coords="1445,244,1534,271" href="include_2mxnet_2ndarray_8h.html" id="node37" shape="rect" title="./ndarray.h"/> |
| <area alt="" coords="1313,326,1404,353" href="storage_8h.html" id="node38" shape="rect" title="Storage manager across multiple devices. "/> |
| </map> |
| </div> |
| </div> |
| <p><a href="operator__util_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">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1op_1_1GradFunctionArgument.html">mxnet::op::GradFunctionArgument</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">super class of all gradient function argument <a href="structmxnet_1_1op_1_1GradFunctionArgument.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_1op_1_1Input0.html">mxnet::op::Input0</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">First input to the function. <a href="structmxnet_1_1op_1_1Input0.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_1op_1_1Input1.html">mxnet::op::Input1</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Second input to the function. <a href="structmxnet_1_1op_1_1Input1.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_1op_1_1OutputValue.html">mxnet::op::OutputValue</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Ouput value of the function to the function. <a href="structmxnet_1_1op_1_1OutputValue.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_1op_1_1OutputGrad.html">mxnet::op::OutputGrad</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Gradient of output value. <a href="structmxnet_1_1op_1_1OutputGrad.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_1op_1_1EnvArguments.html">mxnet::op::EnvArguments</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Environment arguments that is used by the function. These can be things like scalar arguments when add a value with scalar. <a href="structmxnet_1_1op_1_1EnvArguments.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_1op_1_1SimpleOpRegEntry.html">mxnet::op::SimpleOpRegEntry</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">registry entry to register simple operators via functions. <a href="classmxnet_1_1op_1_1SimpleOpRegEntry.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_1op_1_1SimpleOpRegistry.html">mxnet::op::SimpleOpRegistry</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">registry for <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> functions <a href="classmxnet_1_1op_1_1SimpleOpRegistry.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> |
| <tr class="memitem:namespacemxnet_1_1op"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html">mxnet::op</a></td></tr> |
| <tr class="memdesc:namespacemxnet_1_1op"><td class="mdescLeft"> </td><td class="mdescRight">namespace of arguments <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:a0e0ffc581a0c4a40815110163625b517"><td align="right" class="memItemLeft" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="operator__util_8h.html#a0e0ffc581a0c4a40815110163625b517">ASSIGN_DISPATCH</a>(out, req, exp)</td></tr> |
| <tr class="memdesc:a0e0ffc581a0c4a40815110163625b517"><td class="mdescLeft"> </td><td class="mdescRight">assign the expression to out according to request <a href="#a0e0ffc581a0c4a40815110163625b517">More...</a><br/></td></tr> |
| <tr class="separator:a0e0ffc581a0c4a40815110163625b517"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad815e6121771b9c0e292674c7b966f22"><td align="right" class="memItemLeft" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="operator__util_8h.html#ad815e6121771b9c0e292674c7b966f22">MXNET_SPECIAL_MAX_NDIM</a> 5</td></tr> |
| <tr class="memdesc:ad815e6121771b9c0e292674c7b966f22"><td class="mdescLeft"> </td><td class="mdescRight">Maximum ndim supported for special operators like broadcasting with non contiguous lhs/rhs. <a href="#ad815e6121771b9c0e292674c7b966f22">More...</a><br/></td></tr> |
| <tr class="separator:ad815e6121771b9c0e292674c7b966f22"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7c62fb645da1e054596c58315aeadc2c"><td align="right" class="memItemLeft" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="operator__util_8h.html#a7c62fb645da1e054596c58315aeadc2c">MXNET_REGISTER_SIMPLE_OP</a>(Name, DEV)</td></tr> |
| <tr class="memdesc:a7c62fb645da1e054596c58315aeadc2c"><td class="mdescLeft"> </td><td class="mdescRight">Macro to register simple operator to both imperative and symbolic API. <a href="#a7c62fb645da1e054596c58315aeadc2c">More...</a><br/></td></tr> |
| <tr class="separator:a7c62fb645da1e054596c58315aeadc2c"><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:a65e8bade5ae0539689b705b921ed9a9d"><td align="right" class="memItemLeft" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#a65e8bade5ae0539689b705b921ed9a9d">mxnet::op::SourceFunction</a>) (const EnvArguments &env, TBlob *ret, OpReqType req, RunContext ctx)</td></tr> |
| <tr class="memdesc:a65e8bade5ae0539689b705b921ed9a9d"><td class="mdescLeft"> </td><td class="mdescRight">source function that generate output based on env The result container is pre-allocated with the correct shape. <a href="namespacemxnet_1_1op.html#a65e8bade5ae0539689b705b921ed9a9d">More...</a><br/></td></tr> |
| <tr class="separator:a65e8bade5ae0539689b705b921ed9a9d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3419f1ab0d1a62068a5e6c59efdc0fc9"><td align="right" class="memItemLeft" valign="top">typedef TShape(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#a3419f1ab0d1a62068a5e6c59efdc0fc9">mxnet::op::SourceShapeFunction</a>) (const EnvArguments &env)</td></tr> |
| <tr class="memdesc:a3419f1ab0d1a62068a5e6c59efdc0fc9"><td class="mdescLeft"> </td><td class="mdescRight">Shape inference function to get the correct shape. <a href="namespacemxnet_1_1op.html#a3419f1ab0d1a62068a5e6c59efdc0fc9">More...</a><br/></td></tr> |
| <tr class="separator:a3419f1ab0d1a62068a5e6c59efdc0fc9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa37d5216112b72e8110fc8654860910b"><td align="right" class="memItemLeft" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#aa37d5216112b72e8110fc8654860910b">mxnet::op::UnaryFunction</a>) (const TBlob &src, const EnvArguments &env, TBlob *ret, OpReqType req, RunContext ctx)</td></tr> |
| <tr class="memdesc:aa37d5216112b72e8110fc8654860910b"><td class="mdescLeft"> </td><td class="mdescRight">Unary function that takes a src and save result to ret. The result container is pre-allocated with the correct shape. <a href="namespacemxnet_1_1op.html#aa37d5216112b72e8110fc8654860910b">More...</a><br/></td></tr> |
| <tr class="separator:aa37d5216112b72e8110fc8654860910b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2d6fbc6ef1e22ea4433b3cf44ad3cef7"><td align="right" class="memItemLeft" valign="top">typedef TShape(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#a2d6fbc6ef1e22ea4433b3cf44ad3cef7">mxnet::op::UnaryShapeFunction</a>) (const TShape &src, const EnvArguments &env)</td></tr> |
| <tr class="memdesc:a2d6fbc6ef1e22ea4433b3cf44ad3cef7"><td class="mdescLeft"> </td><td class="mdescRight">Shape inference function to get the correct shape given source. <a href="namespacemxnet_1_1op.html#a2d6fbc6ef1e22ea4433b3cf44ad3cef7">More...</a><br/></td></tr> |
| <tr class="separator:a2d6fbc6ef1e22ea4433b3cf44ad3cef7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1e5767bffea568a1c38379060cbb68b4"><td align="right" class="memItemLeft" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#a1e5767bffea568a1c38379060cbb68b4">mxnet::op::UnaryGradFunctionT0</a>) (const OutputGrad &out_grad, const EnvArguments &env, TBlob *in_grad, OpReqType req, RunContext ctx)</td></tr> |
| <tr class="memdesc:a1e5767bffea568a1c38379060cbb68b4"><td class="mdescLeft"> </td><td class="mdescRight">Gradient function that takes output value of function and computes gradient wrt to input. <a href="namespacemxnet_1_1op.html#a1e5767bffea568a1c38379060cbb68b4">More...</a><br/></td></tr> |
| <tr class="separator:a1e5767bffea568a1c38379060cbb68b4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6ad11641816278f8fdb6fe87c7fd3740"><td align="right" class="memItemLeft" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#a6ad11641816278f8fdb6fe87c7fd3740">mxnet::op::UnaryGradFunctionT1</a>) (const OutputGrad &out_grad, const OutputValue &out_value, const EnvArguments &env, TBlob *in_grad, OpReqType req, RunContext ctx)</td></tr> |
| <tr class="memdesc:a6ad11641816278f8fdb6fe87c7fd3740"><td class="mdescLeft"> </td><td class="mdescRight">Gradient function that takes output value of function and computes gradient wrt to input. <a href="namespacemxnet_1_1op.html#a6ad11641816278f8fdb6fe87c7fd3740">More...</a><br/></td></tr> |
| <tr class="separator:a6ad11641816278f8fdb6fe87c7fd3740"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac29102128f7e7785493bbb5b7db80997"><td align="right" class="memItemLeft" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#ac29102128f7e7785493bbb5b7db80997">mxnet::op::UnaryGradFunctionT2</a>) (const OutputGrad &out_grad, const Input0 &in_data0, const EnvArguments &env, TBlob *in_grad, OpReqType req, RunContext ctx)</td></tr> |
| <tr class="memdesc:ac29102128f7e7785493bbb5b7db80997"><td class="mdescLeft"> </td><td class="mdescRight">Gradient function that takes input value of function and computes gradient wrt to input. <a href="namespacemxnet_1_1op.html#ac29102128f7e7785493bbb5b7db80997">More...</a><br/></td></tr> |
| <tr class="separator:ac29102128f7e7785493bbb5b7db80997"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a880eff3ebc68810ef133a6d8b77facc9"><td align="right" class="memItemLeft" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#a880eff3ebc68810ef133a6d8b77facc9">mxnet::op::BinaryFunction</a>) (const TBlob &lhs, const TBlob &rhs, const EnvArguments &env, TBlob *ret, OpReqType req, RunContext ctx)</td></tr> |
| <tr class="memdesc:a880eff3ebc68810ef133a6d8b77facc9"><td class="mdescLeft"> </td><td class="mdescRight">Binary function that takes lhs, rhs and save result to ret. The result container is pre-allocated with the correct shape. <a href="namespacemxnet_1_1op.html#a880eff3ebc68810ef133a6d8b77facc9">More...</a><br/></td></tr> |
| <tr class="separator:a880eff3ebc68810ef133a6d8b77facc9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a78c7bd2075894ac41351feca1b1e5c94"><td align="right" class="memItemLeft" valign="top">typedef TShape(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#a78c7bd2075894ac41351feca1b1e5c94">mxnet::op::BinaryShapeFunction</a>) (const TShape &lhs, const TShape &rhs, const EnvArguments &env)</td></tr> |
| <tr class="memdesc:a78c7bd2075894ac41351feca1b1e5c94"><td class="mdescLeft"> </td><td class="mdescRight">Shape inference function to get the correct shape given source shapes. <a href="namespacemxnet_1_1op.html#a78c7bd2075894ac41351feca1b1e5c94">More...</a><br/></td></tr> |
| <tr class="separator:a78c7bd2075894ac41351feca1b1e5c94"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abcef841f759a7874ef50f21ae0226c8a"><td align="right" class="memItemLeft" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#abcef841f759a7874ef50f21ae0226c8a">mxnet::op::BinaryGradFunctionT0</a>) (const OutputGrad &out_grad, const EnvArguments &env, TBlob *lhs_grad, TBlob *rhs_grad, OpReqType req_lhs_grad, OpReqType req_rhs_grad, RunContext ctx)</td></tr> |
| <tr class="memdesc:abcef841f759a7874ef50f21ae0226c8a"><td class="mdescLeft"> </td><td class="mdescRight">Gradient function that takes only output gradient and computes gradient wrt to input. We support total gradient as a whole to make it easy to combine a few ops. <a href="namespacemxnet_1_1op.html#abcef841f759a7874ef50f21ae0226c8a">More...</a><br/></td></tr> |
| <tr class="separator:abcef841f759a7874ef50f21ae0226c8a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a027d1f190d964f7494816733aff6c3f2"><td align="right" class="memItemLeft" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#a027d1f190d964f7494816733aff6c3f2">mxnet::op::BinaryGradFunctionT1</a>) (const OutputGrad &out_grad, const Input0 &lhs, const Input1 &rhs, const EnvArguments &env, TBlob *lhs_grad, TBlob *rhs_grad, OpReqType req_lhs_grad, OpReqType req_rhs_grad, RunContext ctx)</td></tr> |
| <tr class="memdesc:a027d1f190d964f7494816733aff6c3f2"><td class="mdescLeft"> </td><td class="mdescRight">Gradient function that takes inputs of function anod computes gradient wrt to input. <a href="namespacemxnet_1_1op.html#a027d1f190d964f7494816733aff6c3f2">More...</a><br/></td></tr> |
| <tr class="separator:a027d1f190d964f7494816733aff6c3f2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> |
| Enumerations</h2></td></tr> |
| <tr class="memitem:a3c3b8c77865c7c715cfe05ee2b2fa8da"><td align="right" class="memItemLeft" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#a3c3b8c77865c7c715cfe05ee2b2fa8da">mxnet::op::SimpleOpInplaceOption</a> { <br/> |
| <a class="el" href="namespacemxnet_1_1op.html#a3c3b8c77865c7c715cfe05ee2b2fa8daa048c01bf1598f31850baeb2152b005a2">mxnet::op::kNoInplace</a>, |
| <a class="el" href="namespacemxnet_1_1op.html#a3c3b8c77865c7c715cfe05ee2b2fa8daa2c7771fd11a989ca2480963611405bde">mxnet::op::kInplaceInOut</a>, |
| <a class="el" href="namespacemxnet_1_1op.html#a3c3b8c77865c7c715cfe05ee2b2fa8daab7974a6a3982dae42ba00af90dcabd80">mxnet::op::kInplaceOutIn</a>, |
| <a class="el" href="namespacemxnet_1_1op.html#a3c3b8c77865c7c715cfe05ee2b2fa8daa31a764e0ff5966a10e26f7fbff308c18">mxnet::op::kInplaceLhsOut</a>, |
| <br/> |
| <a class="el" href="namespacemxnet_1_1op.html#a3c3b8c77865c7c715cfe05ee2b2fa8daa01a199e9f1e7d97724be8aa618d5a3d4">mxnet::op::kInplaceOutLhs</a> |
| <br/> |
| }<tr class="memdesc:a3c3b8c77865c7c715cfe05ee2b2fa8da"><td class="mdescLeft"> </td><td class="mdescRight">options in the registry to set inplace of operator <a href="namespacemxnet_1_1op.html#a3c3b8c77865c7c715cfe05ee2b2fa8da">More...</a><br/></td></tr> |
| </td></tr> |
| <tr class="separator:a3c3b8c77865c7c715cfe05ee2b2fa8da"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae7310844fa858f1ec6b6428dd6977a13"><td align="right" class="memItemLeft" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#ae7310844fa858f1ec6b6428dd6977a13">mxnet::op::SimpleOpScalarOption</a> { <a class="el" href="namespacemxnet_1_1op.html#ae7310844fa858f1ec6b6428dd6977a13a44de4ba9d059034c023bc755cdc6026a">mxnet::op::kScalarBeforeArray</a>, |
| <a class="el" href="namespacemxnet_1_1op.html#ae7310844fa858f1ec6b6428dd6977a13aa4cab4197f615e92b1fdb61c51e1b9c7">mxnet::op::kArrayBeforeScalar</a> |
| }<tr class="memdesc:ae7310844fa858f1ec6b6428dd6977a13"><td class="mdescLeft"> </td><td class="mdescRight">options in the registry to set symbolic registration <a href="namespacemxnet_1_1op.html#ae7310844fa858f1ec6b6428dd6977a13">More...</a><br/></td></tr> |
| </td></tr> |
| <tr class="separator:ae7310844fa858f1ec6b6428dd6977a13"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a01bb0bb658bedb4d58bf7d11e4b17268"><td align="right" class="memItemLeft" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1op.html#a01bb0bb658bedb4d58bf7d11e4b17268">mxnet::op::SimpleOpRegOption</a> { <a class="el" href="namespacemxnet_1_1op.html#a01bb0bb658bedb4d58bf7d11e4b17268a929ea2e4ea4bffd5119a8bbf296e616b">mxnet::op::kNotRegisterSymbolic</a>, |
| <a class="el" href="namespacemxnet_1_1op.html#a01bb0bb658bedb4d58bf7d11e4b17268a534486ab7c3f672542bfa09b7b6982d1">mxnet::op::kRegisterSymbolic</a> |
| }<tr class="memdesc:a01bb0bb658bedb4d58bf7d11e4b17268"><td class="mdescLeft"> </td><td class="mdescRight">options in the registry to set symbolic registration <a href="namespacemxnet_1_1op.html#a01bb0bb658bedb4d58bf7d11e4b17268">More...</a><br/></td></tr> |
| </td></tr> |
| <tr class="separator:a01bb0bb658bedb4d58bf7d11e4b17268"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Utility functions and registries to help quickly build new operators. [Deprecated] Use the register functions in this file when possible to simplify operator creations. Operators registered in this file will be exposed to both NDArray API and symbolic API. </p> |
| <p>Copyright (c) 2015 by Contributors</p> |
| <dl class="section author"><dt>Author</dt><dd>Tianqi Chen </dd></dl> |
| </div><h2 class="groupheader">Macro Definition Documentation</h2> |
| <a class="anchor" id="a0e0ffc581a0c4a40815110163625b517"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define ASSIGN_DISPATCH</td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname">out, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname">req, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname">exp </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">{ \</div><div class="line"> switch (req) { \</div><div class="line"> case <a class="code" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398a001b85096e07108e174fe4c406368a26">kNullOp</a>: \</div><div class="line"> break; \</div><div class="line"> case <a class="code" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398a03b4c19f34d3add7deecd7ef6c54b42a">kWriteTo</a>: \</div><div class="line"> case <a class="code" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398a640322face587ca12684378d0f053d51">kWriteInplace</a>: \</div><div class="line"> (out) = (<a class="code" href="namespacemxnet_1_1cpp.html#af9cfdd6329c237d4b9ee144c24f51900">exp</a>); \</div><div class="line"> break; \</div><div class="line"> case <a class="code" href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398a1b850737dba4d2c42a2687d14c10f383">kAddTo</a>: \</div><div class="line"> (out) += (<a class="code" href="namespacemxnet_1_1cpp.html#af9cfdd6329c237d4b9ee144c24f51900">exp</a>); \</div><div class="line"> break; \</div><div class="line"> default: \</div><div class="line"> LOG(FATAL) << <span class="stringliteral">"not reached"</span>; \</div><div class="line"> } \</div><div class="line"> }</div><div class="ttc" id="namespacemxnet_1_1cpp_html_af9cfdd6329c237d4b9ee144c24f51900"><div class="ttname"><a href="namespacemxnet_1_1cpp.html#af9cfdd6329c237d4b9ee144c24f51900">mxnet::cpp::exp</a></div><div class="ttdeci">Symbol exp(const std::string &symbol_name, Symbol data)</div><div class="ttdef"><b>Definition:</b> op.h:1989</div></div> |
| <div class="ttc" id="namespacemxnet_html_a7cd7094ef222e9ae1f520c3b6a214398a001b85096e07108e174fe4c406368a26"><div class="ttname"><a href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398a001b85096e07108e174fe4c406368a26">mxnet::kNullOp</a></div><div class="ttdoc">no operation, do not write anything </div><div class="ttdef"><b>Definition:</b> op_attr_types.h:47</div></div> |
| <div class="ttc" id="namespacemxnet_html_a7cd7094ef222e9ae1f520c3b6a214398a03b4c19f34d3add7deecd7ef6c54b42a"><div class="ttname"><a href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398a03b4c19f34d3add7deecd7ef6c54b42a">mxnet::kWriteTo</a></div><div class="ttdoc">write gradient to provided space </div><div class="ttdef"><b>Definition:</b> op_attr_types.h:49</div></div> |
| <div class="ttc" id="namespacemxnet_html_a7cd7094ef222e9ae1f520c3b6a214398a640322face587ca12684378d0f053d51"><div class="ttname"><a href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398a640322face587ca12684378d0f053d51">mxnet::kWriteInplace</a></div><div class="ttdoc">perform an inplace write, This option only happen when Target shares memory with one of input argumen...</div><div class="ttdef"><b>Definition:</b> op_attr_types.h:55</div></div> |
| <div class="ttc" id="namespacemxnet_html_a7cd7094ef222e9ae1f520c3b6a214398a1b850737dba4d2c42a2687d14c10f383"><div class="ttname"><a href="namespacemxnet.html#a7cd7094ef222e9ae1f520c3b6a214398a1b850737dba4d2c42a2687d14c10f383">mxnet::kAddTo</a></div><div class="ttdoc">add to the provided space </div><div class="ttdef"><b>Definition:</b> op_attr_types.h:57</div></div> |
| </div><!-- fragment --> |
| <p>assign the expression to out according to request </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">out</td><td>the data to be assigned </td></tr> |
| <tr><td class="paramname">req</td><td>the assignment request </td></tr> |
| <tr><td class="paramname">exp</td><td>the expression </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">OType</td><td>output type </td></tr> |
| <tr><td class="paramname">Exp</td><td>expression type </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <a class="anchor" id="a7c62fb645da1e054596c58315aeadc2c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define MXNET_REGISTER_SIMPLE_OP</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">DEV </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">static ::mxnet::op::SimpleOpRegEntry & \</div><div class="line"> __make_ ## SimpleOpRegEntry ## _ ## Name ## __ ## DEV ##__ = <a class="code" href="classmxnet_1_1op_1_1SimpleOpRegistry.html#a374ec19d647f622c80a79fb3d541e7ec">\</a></div><div class="line"><a class="code" href="classmxnet_1_1op_1_1SimpleOpRegistry.html#a374ec19d647f622c80a79fb3d541e7ec"> ::mxnet::op::SimpleOpRegistry::Get</a>()-><a class="code" href="classmxnet_1_1op_1_1SimpleOpRegistry.html#a376e3412e9f425db998c384e5d3f0523">__REGISTER_OR_FIND__</a>(#Name)</div><div class="ttc" id="classmxnet_1_1op_1_1SimpleOpRegistry_html_a374ec19d647f622c80a79fb3d541e7ec"><div class="ttname"><a href="classmxnet_1_1op_1_1SimpleOpRegistry.html#a374ec19d647f622c80a79fb3d541e7ec">mxnet::op::SimpleOpRegistry::Get</a></div><div class="ttdeci">static SimpleOpRegistry * Get()</div></div> |
| <div class="ttc" id="classmxnet_1_1op_1_1SimpleOpRegistry_html_a376e3412e9f425db998c384e5d3f0523"><div class="ttname"><a href="classmxnet_1_1op_1_1SimpleOpRegistry.html#a376e3412e9f425db998c384e5d3f0523">mxnet::op::SimpleOpRegistry::__REGISTER_OR_FIND__</a></div><div class="ttdeci">SimpleOpRegEntry & __REGISTER_OR_FIND__(char const *name)</div><div class="ttdoc">Internal function to register a name function under name. </div></div> |
| </div><!-- fragment --> |
| <p>Macro to register simple operator to both imperative and symbolic API. </p> |
| <p>see src/operator/elementwise_unary_op-inl.h for example</p> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> // example of registering a sigmoid operator on GPU</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> // MySigmoid is of type UnaryFunction,</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> // MySigmoidGrad is of type UnaryGradFunctionT2</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> MXNET_REGISTER_SIMPLE_OP(sigmoid, cpu)</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> .set_function(MySigmoid<gpu>, true)</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> .set_gradient(MySigmoidGrad<gpu>, true)</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> .describe("Sigmoid function");</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="ad815e6121771b9c0e292674c7b966f22"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define MXNET_SPECIAL_MAX_NDIM 5</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Maximum ndim supported for special operators like broadcasting with non contiguous lhs/rhs. </p> |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Sep 19 2019 12:53:03 for mxnet by <a href="http://www.doxygen.org/index.html"> |
| <img alt="doxygen" class="footer" src="doxygen.png"/> |
| </a> 1.8.11 |
| </small></address> |
| </body> |
| </html> |
