| <!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: mxnet::ext::CustomStatefulOp Class 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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1ext.html">ext</a></li><li class="navelem"><a class="el" href="classmxnet_1_1ext_1_1CustomStatefulOp.html">CustomStatefulOp</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="classmxnet_1_1ext_1_1CustomStatefulOp-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::ext::CustomStatefulOp Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An abstract class for library authors creating stateful op custom library should override Forward and destructor, and has an option to implement Backward. |
| <a href="classmxnet_1_1ext_1_1CustomStatefulOp.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="lib__api_8h_source.html">lib_api.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::ext::CustomStatefulOp:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1ext_1_1CustomStatefulOp__coll__graph.png" border="0" usemap="#mxnet_1_1ext_1_1CustomStatefulOp_coll__map" alt="Collaboration graph"/></div> |
| <map name="mxnet_1_1ext_1_1CustomStatefulOp_coll__map" id="mxnet_1_1ext_1_1CustomStatefulOp_coll__map"> |
| </map> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:adacc6e8d18cc2428ace58c96111e6f39"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1CustomStatefulOp.html#adacc6e8d18cc2428ace58c96111e6f39">CustomStatefulOp</a> ()</td></tr> |
| <tr class="separator:adacc6e8d18cc2428ace58c96111e6f39"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acbf1b61e0f1cb13ba9df92cf2774ba7b"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1CustomStatefulOp.html#acbf1b61e0f1cb13ba9df92cf2774ba7b">~CustomStatefulOp</a> ()</td></tr> |
| <tr class="separator:acbf1b61e0f1cb13ba9df92cf2774ba7b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a46fb6fe57019f1ef4d4a616c7ef7297f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1CustomStatefulOp.html#a46fb6fe57019f1ef4d4a616c7ef7297f">wasCreated</a> ()</td></tr> |
| <tr class="separator:a46fb6fe57019f1ef4d4a616c7ef7297f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a96fa3699ce4d0324480cc0185d49cf30"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacemxnet_1_1ext.html#a2a16b18af2cdbff088a3c76d62b39b40">MXReturnValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1CustomStatefulOp.html#a96fa3699ce4d0324480cc0185d49cf30">Forward</a> (std::vector< <a class="el" href="structmxnet_1_1ext_1_1MXTensor.html">MXTensor</a> > *inputs, std::vector< <a class="el" href="structmxnet_1_1ext_1_1MXTensor.html">MXTensor</a> > *outputs, const <a class="el" href="classmxnet_1_1ext_1_1OpResource.html">OpResource</a> &op_res)=0</td></tr> |
| <tr class="separator:a96fa3699ce4d0324480cc0185d49cf30"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad8758d40952666f93d644f704b686da6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacemxnet_1_1ext.html#a2a16b18af2cdbff088a3c76d62b39b40">MXReturnValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1CustomStatefulOp.html#ad8758d40952666f93d644f704b686da6">Backward</a> (std::vector< <a class="el" href="structmxnet_1_1ext_1_1MXTensor.html">MXTensor</a> > *inputs, std::vector< <a class="el" href="structmxnet_1_1ext_1_1MXTensor.html">MXTensor</a> > *outputs, const <a class="el" href="classmxnet_1_1ext_1_1OpResource.html">OpResource</a> &op_res)</td></tr> |
| <tr class="separator:ad8758d40952666f93d644f704b686da6"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:aa48c6b2f073ef04c5d69060fd1aedf1d"><td class="memTemplParams" colspan="2">template<class A , typename ... Ts> </td></tr> |
| <tr class="memitem:aa48c6b2f073ef04c5d69060fd1aedf1d"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classmxnet_1_1ext_1_1CustomStatefulOp.html">CustomStatefulOp</a> * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1CustomStatefulOp.html#aa48c6b2f073ef04c5d69060fd1aedf1d">create</a> (Ts...args)</td></tr> |
| <tr class="separator:aa48c6b2f073ef04c5d69060fd1aedf1d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:aca7db0bccdf4840d5cd70ff73f7624da"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1CustomStatefulOp.html#aca7db0bccdf4840d5cd70ff73f7624da">ignore_warn</a></td></tr> |
| <tr class="separator:aca7db0bccdf4840d5cd70ff73f7624da"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An abstract class for library authors creating stateful op custom library should override Forward and destructor, and has an option to implement Backward. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="adacc6e8d18cc2428ace58c96111e6f39"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adacc6e8d18cc2428ace58c96111e6f39">◆ </a></span>CustomStatefulOp()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::ext::CustomStatefulOp::CustomStatefulOp </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="acbf1b61e0f1cb13ba9df92cf2774ba7b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acbf1b61e0f1cb13ba9df92cf2774ba7b">◆ </a></span>~CustomStatefulOp()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual mxnet::ext::CustomStatefulOp::~CustomStatefulOp </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ad8758d40952666f93d644f704b686da6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad8758d40952666f93d644f704b686da6">◆ </a></span>Backward()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="namespacemxnet_1_1ext.html#a2a16b18af2cdbff088a3c76d62b39b40">MXReturnValue</a> mxnet::ext::CustomStatefulOp::Backward </td> |
| <td>(</td> |
| <td class="paramtype">std::vector< <a class="el" href="structmxnet_1_1ext_1_1MXTensor.html">MXTensor</a> > * </td> |
| <td class="paramname"><em>inputs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< <a class="el" href="structmxnet_1_1ext_1_1MXTensor.html">MXTensor</a> > * </td> |
| <td class="paramname"><em>outputs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classmxnet_1_1ext_1_1OpResource.html">OpResource</a> & </td> |
| <td class="paramname"><em>op_res</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="aa48c6b2f073ef04c5d69060fd1aedf1d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa48c6b2f073ef04c5d69060fd1aedf1d">◆ </a></span>create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class A , typename ... Ts> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classmxnet_1_1ext_1_1CustomStatefulOp.html">CustomStatefulOp</a>* mxnet::ext::CustomStatefulOp::create </td> |
| <td>(</td> |
| <td class="paramtype">Ts... </td> |
| <td class="paramname"><em>args</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a96fa3699ce4d0324480cc0185d49cf30"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a96fa3699ce4d0324480cc0185d49cf30">◆ </a></span>Forward()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="namespacemxnet_1_1ext.html#a2a16b18af2cdbff088a3c76d62b39b40">MXReturnValue</a> mxnet::ext::CustomStatefulOp::Forward </td> |
| <td>(</td> |
| <td class="paramtype">std::vector< <a class="el" href="structmxnet_1_1ext_1_1MXTensor.html">MXTensor</a> > * </td> |
| <td class="paramname"><em>inputs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< <a class="el" href="structmxnet_1_1ext_1_1MXTensor.html">MXTensor</a> > * </td> |
| <td class="paramname"><em>outputs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classmxnet_1_1ext_1_1OpResource.html">OpResource</a> & </td> |
| <td class="paramname"><em>op_res</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a46fb6fe57019f1ef4d4a616c7ef7297f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a46fb6fe57019f1ef4d4a616c7ef7297f">◆ </a></span>wasCreated()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mxnet::ext::CustomStatefulOp::wasCreated </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="aca7db0bccdf4840d5cd70ff73f7624da"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aca7db0bccdf4840d5cd70ff73f7624da">◆ </a></span>ignore_warn</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mxnet::ext::CustomStatefulOp::ignore_warn</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/include/mxnet/<a class="el" href="lib__api_8h_source.html">lib_api.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:44 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
