| <!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: nnvm::Op 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.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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="namespacennvm.html">nnvm</a></li><li class="navelem"><a class="el" href="classnnvm_1_1Op.html">Op</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="#friends">Friends</a> | |
| <a href="classnnvm_1_1Op-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">nnvm::Op Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Operator structure. |
| <a href="classnnvm_1_1Op.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="op_8h_source.html">op.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for nnvm::Op:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classnnvm_1_1Op__coll__graph.png" border="0" usemap="#nnvm_1_1Op_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </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:abab5b3bef4265a194fced208f2e8292b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Op.html">Op</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#abab5b3bef4265a194fced208f2e8292b">describe</a> (const std::string &descr)</td></tr> |
| <tr class="memdesc:abab5b3bef4265a194fced208f2e8292b"><td class="mdescLeft"> </td><td class="mdescRight">setter function during registration Set the description of operator <a href="classnnvm_1_1Op.html#abab5b3bef4265a194fced208f2e8292b">More...</a><br /></td></tr> |
| <tr class="separator:abab5b3bef4265a194fced208f2e8292b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a36256680ebbb00708381115c5b8ab817"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Op.html">Op</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a36256680ebbb00708381115c5b8ab817">add_argument</a> (const std::string &<a class="el" href="classnnvm_1_1Op.html#af67a5d6998765023aeed6761df292b6c">name</a>, const std::string &type, const std::string &<a class="el" href="classnnvm_1_1Op.html#a9552f756aa56608379096b6ca727ccf5">description</a>)</td></tr> |
| <tr class="memdesc:a36256680ebbb00708381115c5b8ab817"><td class="mdescLeft"> </td><td class="mdescRight">Add argument information to the function. <a href="classnnvm_1_1Op.html#a36256680ebbb00708381115c5b8ab817">More...</a><br /></td></tr> |
| <tr class="separator:a36256680ebbb00708381115c5b8ab817"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad3d42bec8afaf4e50d59be89a1795035"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Op.html">Op</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#ad3d42bec8afaf4e50d59be89a1795035">add_arguments</a> (const std::vector< ParamFieldInfo > &args)</td></tr> |
| <tr class="memdesc:ad3d42bec8afaf4e50d59be89a1795035"><td class="mdescLeft"> </td><td class="mdescRight">Append list if arguments to the end. <a href="classnnvm_1_1Op.html#ad3d42bec8afaf4e50d59be89a1795035">More...</a><br /></td></tr> |
| <tr class="separator:ad3d42bec8afaf4e50d59be89a1795035"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2db3c272965df71f1e592ea30a1c824a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Op.html">Op</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a2db3c272965df71f1e592ea30a1c824a">set_num_inputs</a> (uint32_t n)</td></tr> |
| <tr class="memdesc:a2db3c272965df71f1e592ea30a1c824a"><td class="mdescLeft"> </td><td class="mdescRight">Set the num_inputs. <a href="classnnvm_1_1Op.html#a2db3c272965df71f1e592ea30a1c824a">More...</a><br /></td></tr> |
| <tr class="separator:a2db3c272965df71f1e592ea30a1c824a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa9ec331b85b57d31951c4bd3ff8a1473"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Op.html">Op</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#aa9ec331b85b57d31951c4bd3ff8a1473">set_support_level</a> (uint32_t level)</td></tr> |
| <tr class="memdesc:aa9ec331b85b57d31951c4bd3ff8a1473"><td class="mdescLeft"> </td><td class="mdescRight">Set the support level of op. <a href="classnnvm_1_1Op.html#aa9ec331b85b57d31951c4bd3ff8a1473">More...</a><br /></td></tr> |
| <tr class="separator:aa9ec331b85b57d31951c4bd3ff8a1473"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aab25f32ae369dc760f73ca75caa17f2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Op.html">Op</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#aab25f32ae369dc760f73ca75caa17f2d">set_num_inputs</a> (std::function< uint32_t(const <a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a> &attr)> fn)</td></tr> |
| <tr class="memdesc:aab25f32ae369dc760f73ca75caa17f2d"><td class="mdescLeft"> </td><td class="mdescRight">Set the get_num_outputs function. <a href="classnnvm_1_1Op.html#aab25f32ae369dc760f73ca75caa17f2d">More...</a><br /></td></tr> |
| <tr class="separator:aab25f32ae369dc760f73ca75caa17f2d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a034baf61a5f396d400073433e92bea51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Op.html">Op</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a034baf61a5f396d400073433e92bea51">set_num_outputs</a> (uint32_t n)</td></tr> |
| <tr class="memdesc:a034baf61a5f396d400073433e92bea51"><td class="mdescLeft"> </td><td class="mdescRight">Set the num_outputs. <a href="classnnvm_1_1Op.html#a034baf61a5f396d400073433e92bea51">More...</a><br /></td></tr> |
| <tr class="separator:a034baf61a5f396d400073433e92bea51"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa7b1b4661e24f8d9ca02c13443cbf6b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Op.html">Op</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#aa7b1b4661e24f8d9ca02c13443cbf6b6">set_num_outputs</a> (std::function< uint32_t(const <a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a> &attr)> fn)</td></tr> |
| <tr class="memdesc:aa7b1b4661e24f8d9ca02c13443cbf6b6"><td class="mdescLeft"> </td><td class="mdescRight">Set the get_num_outputs function. <a href="classnnvm_1_1Op.html#aa7b1b4661e24f8d9ca02c13443cbf6b6">More...</a><br /></td></tr> |
| <tr class="separator:aa7b1b4661e24f8d9ca02c13443cbf6b6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3af40f342a817a47f1fb7769ab0866ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Op.html">Op</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a3af40f342a817a47f1fb7769ab0866ea">set_attr_parser</a> (std::function< void(<a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a> *attrs)> fn)</td></tr> |
| <tr class="memdesc:a3af40f342a817a47f1fb7769ab0866ea"><td class="mdescLeft"> </td><td class="mdescRight">Set the attr_parser function. <a href="classnnvm_1_1Op.html#a3af40f342a817a47f1fb7769ab0866ea">More...</a><br /></td></tr> |
| <tr class="separator:a3af40f342a817a47f1fb7769ab0866ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6ddb1adaac8e03ae1f66fc41ca927224"><td class="memTemplParams" colspan="2">template<typename ValueType > </td></tr> |
| <tr class="memitem:a6ddb1adaac8e03ae1f66fc41ca927224"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Op.html">Op</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a6ddb1adaac8e03ae1f66fc41ca927224">set_attr</a> (const std::string &attr_name, const ValueType &value, int plevel=10)</td></tr> |
| <tr class="memdesc:a6ddb1adaac8e03ae1f66fc41ca927224"><td class="mdescLeft"> </td><td class="mdescRight">Register additional attributes to operator. <a href="classnnvm_1_1Op.html#a6ddb1adaac8e03ae1f66fc41ca927224">More...</a><br /></td></tr> |
| <tr class="separator:a6ddb1adaac8e03ae1f66fc41ca927224"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16973b4b52a100fcc2de55c57af5d36b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Op.html">Op</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a16973b4b52a100fcc2de55c57af5d36b">add_alias</a> (const std::string &alias)</td></tr> |
| <tr class="memdesc:a16973b4b52a100fcc2de55c57af5d36b"><td class="mdescLeft"> </td><td class="mdescRight">Add another alias to this operator. The same <a class="el" href="classnnvm_1_1Op.html" title="Operator structure.">Op</a> can be queried with Op::Get(alias) <a href="classnnvm_1_1Op.html#a16973b4b52a100fcc2de55c57af5d36b">More...</a><br /></td></tr> |
| <tr class="separator:a16973b4b52a100fcc2de55c57af5d36b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac1f00108da268063c4b14f63f73af92a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Op.html">Op</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#ac1f00108da268063c4b14f63f73af92a">include</a> (const std::string &group_name)</td></tr> |
| <tr class="memdesc:ac1f00108da268063c4b14f63f73af92a"><td class="mdescLeft"> </td><td class="mdescRight">Include all the attributes from an registered op group. <a href="classnnvm_1_1Op.html#ac1f00108da268063c4b14f63f73af92a">More...</a><br /></td></tr> |
| <tr class="separator:ac1f00108da268063c4b14f63f73af92a"><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:a47a2e6f4e2607cd4dd815b53809b14a3"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classnnvm_1_1Op.html">Op</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a47a2e6f4e2607cd4dd815b53809b14a3">Get</a> (const std::string &op_name)</td></tr> |
| <tr class="memdesc:a47a2e6f4e2607cd4dd815b53809b14a3"><td class="mdescLeft"> </td><td class="mdescRight">Get an <a class="el" href="classnnvm_1_1Op.html" title="Operator structure.">Op</a> for a given operator name. Will raise an error if the op has not been registered. <a href="classnnvm_1_1Op.html#a47a2e6f4e2607cd4dd815b53809b14a3">More...</a><br /></td></tr> |
| <tr class="separator:a47a2e6f4e2607cd4dd815b53809b14a3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a97b65edf5226493f41f4a81e13e6abec"><td class="memTemplParams" colspan="2">template<typename ValueType > </td></tr> |
| <tr class="memitem:a97b65edf5226493f41f4a81e13e6abec"><td class="memTemplItemLeft" align="right" valign="top">static const <a class="el" href="classnnvm_1_1OpMap.html">OpMap</a>< ValueType > & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a97b65edf5226493f41f4a81e13e6abec">GetAttr</a> (const std::string &attr_name)</td></tr> |
| <tr class="memdesc:a97b65edf5226493f41f4a81e13e6abec"><td class="mdescLeft"> </td><td class="mdescRight">Get additional registered attribute about operators. If nothing has been registered, an empty <a class="el" href="classnnvm_1_1OpMap.html" title="A map data structure that takes Op* as key and returns ValueType.">OpMap</a> will be returned. <a href="classnnvm_1_1Op.html#a97b65edf5226493f41f4a81e13e6abec">More...</a><br /></td></tr> |
| <tr class="separator:a97b65edf5226493f41f4a81e13e6abec"><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:af67a5d6998765023aeed6761df292b6c"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#af67a5d6998765023aeed6761df292b6c">name</a></td></tr> |
| <tr class="memdesc:af67a5d6998765023aeed6761df292b6c"><td class="mdescLeft"> </td><td class="mdescRight">name of the operator <a href="classnnvm_1_1Op.html#af67a5d6998765023aeed6761df292b6c">More...</a><br /></td></tr> |
| <tr class="separator:af67a5d6998765023aeed6761df292b6c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9552f756aa56608379096b6ca727ccf5"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a9552f756aa56608379096b6ca727ccf5">description</a></td></tr> |
| <tr class="memdesc:a9552f756aa56608379096b6ca727ccf5"><td class="mdescLeft"> </td><td class="mdescRight">detailed description of the operator This can be used to generate docstring automatically for the operator. <a href="classnnvm_1_1Op.html#a9552f756aa56608379096b6ca727ccf5">More...</a><br /></td></tr> |
| <tr class="separator:a9552f756aa56608379096b6ca727ccf5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8d63a704ebbd55974b66e6efd75b3722"><td class="memItemLeft" align="right" valign="top">std::vector< ParamFieldInfo > </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a8d63a704ebbd55974b66e6efd75b3722">arguments</a></td></tr> |
| <tr class="separator:a8d63a704ebbd55974b66e6efd75b3722"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a040c73b911bfb98b3ea9ebc71deed112"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a040c73b911bfb98b3ea9ebc71deed112">num_inputs</a> = 1</td></tr> |
| <tr class="memdesc:a040c73b911bfb98b3ea9ebc71deed112"><td class="mdescLeft"> </td><td class="mdescRight">number of inputs to the operator, -1 means it is variable length When get_num_inputs is presented, the number will be decided by get_num_inputs instead. <a href="classnnvm_1_1Op.html#a040c73b911bfb98b3ea9ebc71deed112">More...</a><br /></td></tr> |
| <tr class="separator:a040c73b911bfb98b3ea9ebc71deed112"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a69435cb4f8b3187a98e938a66d31a610"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a69435cb4f8b3187a98e938a66d31a610">num_outputs</a> = 1</td></tr> |
| <tr class="memdesc:a69435cb4f8b3187a98e938a66d31a610"><td class="mdescLeft"> </td><td class="mdescRight">number of outputs of the operator When get_num_outputs is presented. The number of outputs will be decided by get_num_outputs function <a href="classnnvm_1_1Op.html#a69435cb4f8b3187a98e938a66d31a610">More...</a><br /></td></tr> |
| <tr class="separator:a69435cb4f8b3187a98e938a66d31a610"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af9ca45839dffc509576b193683dcfc1c"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#af9ca45839dffc509576b193683dcfc1c">support_level</a> = 10</td></tr> |
| <tr class="memdesc:af9ca45839dffc509576b193683dcfc1c"><td class="mdescLeft"> </td><td class="mdescRight">support level of the operator, The lower the more priority it contains. This is in analogies to BLAS levels. <a href="classnnvm_1_1Op.html#af9ca45839dffc509576b193683dcfc1c">More...</a><br /></td></tr> |
| <tr class="separator:af9ca45839dffc509576b193683dcfc1c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a676849f49f99c9a299d5c50cf00f3b5b"><td class="memItemLeft" align="right" valign="top">std::function< uint32_t(const <a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a> &attrs)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a676849f49f99c9a299d5c50cf00f3b5b">get_num_outputs</a> = nullptr</td></tr> |
| <tr class="memdesc:a676849f49f99c9a299d5c50cf00f3b5b"><td class="mdescLeft"> </td><td class="mdescRight">get number of outputs given information about the node. <a href="classnnvm_1_1Op.html#a676849f49f99c9a299d5c50cf00f3b5b">More...</a><br /></td></tr> |
| <tr class="separator:a676849f49f99c9a299d5c50cf00f3b5b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaed55d545403aca8cd4fff730c40e4bd"><td class="memItemLeft" align="right" valign="top">std::function< uint32_t(const <a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a> &attrs)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#aaed55d545403aca8cd4fff730c40e4bd">get_num_inputs</a> = nullptr</td></tr> |
| <tr class="memdesc:aaed55d545403aca8cd4fff730c40e4bd"><td class="mdescLeft"> </td><td class="mdescRight">get number of inputs given information about the node. <a href="classnnvm_1_1Op.html#aaed55d545403aca8cd4fff730c40e4bd">More...</a><br /></td></tr> |
| <tr class="separator:aaed55d545403aca8cd4fff730c40e4bd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7781df54dc846bee7d847638e675b959"><td class="memItemLeft" align="right" valign="top">std::function< void(<a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a> *attrs)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#a7781df54dc846bee7d847638e675b959">attr_parser</a> = nullptr</td></tr> |
| <tr class="memdesc:a7781df54dc846bee7d847638e675b959"><td class="mdescLeft"> </td><td class="mdescRight">Attribute parser to parse the <a class="el" href="structnnvm_1_1NodeAttrs.html" title="The attributes of the current operation node. Usually are additional parameters like axis,...">NodeAttrs</a> information. <a href="classnnvm_1_1Op.html#a7781df54dc846bee7d847638e675b959">More...</a><br /></td></tr> |
| <tr class="separator:a7781df54dc846bee7d847638e675b959"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:afcf7d46a60dd033ce159ceceec21db70"><td class="memTemplParams" colspan="2">template<typename ValueType > </td></tr> |
| <tr class="memitem:afcf7d46a60dd033ce159ceceec21db70"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#afcf7d46a60dd033ce159ceceec21db70">OpMap</a></td></tr> |
| <tr class="separator:afcf7d46a60dd033ce159ceceec21db70"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa78b2abaef315001da64cae7a8050e61"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#aa78b2abaef315001da64cae7a8050e61">OpGroup</a></td></tr> |
| <tr class="separator:aa78b2abaef315001da64cae7a8050e61"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac27d3a3a32f9258272ec64e446b539eb"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Op.html#ac27d3a3a32f9258272ec64e446b539eb">dmlc::Registry< Op ></a></td></tr> |
| <tr class="separator:ac27d3a3a32f9258272ec64e446b539eb"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Operator structure. </p> |
| <p>Besides the fields in the structure, arbitary additional information can be associated with each op. See function GetAttr for details.</p> |
| <div class="fragment"><div class="line"> <span class="comment">// Example usage of Op</span></div> |
| <div class="line"> </div> |
| <div class="line"> <span class="comment">// registeration of oeprators</span></div> |
| <div class="line"> <span class="comment">// NOTE that the attr function can register any</span></div> |
| <div class="line"> <span class="comment">// additional attributes to the operator</span></div> |
| <div class="line"> <a class="code" href="op_8h.html#aacfc49292e41582dd1bba725ece160ae">NNVM_REGISTER_OP</a>(add)</div> |
| <div class="line"> .describe(<span class="stringliteral">"add two inputs together"</span>)</div> |
| <div class="line"> .set_num_inputs(2)</div> |
| <div class="line"> .set_attr<OpKernel>(<span class="stringliteral">"OpKernel<gpu>"</span>, AddKernel)</div> |
| <div class="line"> .<a class="code" href="classnnvm_1_1Op.html#ac1f00108da268063c4b14f63f73af92a">include</a>(<span class="stringliteral">"ElementwiseOpAttr"</span>);</div> |
| <div class="line"> </div> |
| <div class="line"> <span class="comment">// can register attribute by group</span></div> |
| <div class="line"> <span class="comment">// all the ops that include the group get the attribute.</span></div> |
| <div class="line"> <a class="code" href="op_8h.html#af0e87dbf2cd566db02e76ea77f14f20b">NNVM_REGISTER_OP_GROUP</a>(ElementwiseOpAttr)</div> |
| <div class="line"> .set_attr<<a class="code" href="namespacennvm.html#ae80cd6cc2432e36350ad84335d5e5308">FInferShape</a>>(<span class="stringliteral">"FInferShape"</span>, ElementwiseInferShape);</div> |
| <div class="line"> </div> |
| <div class="line"> <a class="code" href="op_8h.html#aacfc49292e41582dd1bba725ece160ae">NNVM_REGISTER_OP</a>(sub)</div> |
| <div class="line"> .describe(<span class="stringliteral">"substract one tensor from another"</span>)</div> |
| <div class="line"> .set_num_inputs(2);</div> |
| <div class="line"> </div> |
| <div class="line"> <span class="comment">// Can call regster multiple times in different files</span></div> |
| <div class="line"> <span class="comment">// to register different part of information</span></div> |
| <div class="line"> <a class="code" href="op_8h.html#aacfc49292e41582dd1bba725ece160ae">NNVM_REGISTER_OP</a>(sub)</div> |
| <div class="line"> .set_attr<OpKernel>(<span class="stringliteral">"OpKernel<gpu>"</span>, SubKernel);</div> |
| <div class="line"> .include(<span class="stringliteral">"ElementwiseOpAttr"</span>);</div> |
| <div class="line"> </div> |
| <div class="line"> <span class="comment">// get operators from registry.</span></div> |
| <div class="line"> <span class="keywordtype">void</span> my_function() {</div> |
| <div class="line"> <span class="keyword">const</span> <a class="code" href="namespacemxnet.html#ac2fb286fd7ddfbc7af1456f6c7a7ee52">Op</a>* add = <a class="code" href="classnnvm_1_1Op.html#a47a2e6f4e2607cd4dd815b53809b14a3">Op::Get</a>(<span class="stringliteral">"add"</span>);</div> |
| <div class="line"> <span class="keyword">const</span> <a class="code" href="namespacemxnet.html#ac2fb286fd7ddfbc7af1456f6c7a7ee52">Op</a>* sub = <a class="code" href="classnnvm_1_1Op.html#a47a2e6f4e2607cd4dd815b53809b14a3">Op::Get</a>(<span class="stringliteral">"sub"</span>);</div> |
| <div class="line"> <span class="comment">// query basic information about each operator.</span></div> |
| <div class="line"> assert(op->name == <span class="stringliteral">"plus"</span>);</div> |
| <div class="line"> assert(op->num_inputs == 2);</div> |
| <div class="line"> </div> |
| <div class="line"> <span class="comment">// get additional registered information,</span></div> |
| <div class="line"> <span class="comment">// Assume user registered a OpKernel type attribute as gpu_kernel on each operator.</span></div> |
| <div class="line"> <span class="keyword">const</span> OpMap<OpKernel>& kernel = Op::GetAttr<OpKernel>(<span class="stringliteral">"OpKernel<gpu>"</span>);</div> |
| <div class="line"> <span class="comment">// we can get the kernel functions by using operator as key.</span></div> |
| <div class="line"> <span class="keyword">auto</span> add_kernel = kernel[add];</div> |
| <div class="line"> <span class="keyword">auto</span> sub_kernel = kernel[sub];</div> |
| <div class="line"> <span class="comment">// subsequent code can make use of the queried kernel functions.</span></div> |
| <div class="line">}</div> |
| </div><!-- fragment --> </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a16973b4b52a100fcc2de55c57af5d36b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a16973b4b52a100fcc2de55c57af5d36b">◆ </a></span>add_alias()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Op.html">Op</a>& nnvm::Op::add_alias </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>alias</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add another alias to this operator. The same <a class="el" href="classnnvm_1_1Op.html" title="Operator structure.">Op</a> can be queried with Op::Get(alias) </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">alias</td><td>The alias of the operator. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a36256680ebbb00708381115c5b8ab817"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a36256680ebbb00708381115c5b8ab817">◆ </a></span>add_argument()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Op.html">Op</a> & nnvm::Op::add_argument </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>type</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>description</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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add argument information to the function. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>Name of the argument. </td></tr> |
| <tr><td class="paramname">type</td><td>Type of the argument. </td></tr> |
| <tr><td class="paramname">description</td><td>Description of the argument. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad3d42bec8afaf4e50d59be89a1795035"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad3d42bec8afaf4e50d59be89a1795035">◆ </a></span>add_arguments()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Op.html">Op</a> & nnvm::Op::add_arguments </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< ParamFieldInfo > & </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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Append list if arguments to the end. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">args</td><td>Additional list of arguments. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="abab5b3bef4265a194fced208f2e8292b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abab5b3bef4265a194fced208f2e8292b">◆ </a></span>describe()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Op.html">Op</a> & nnvm::Op::describe </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>descr</em></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"> |
| |
| <p>setter function during registration Set the description of operator </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">descr</td><td>the description string. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a47a2e6f4e2607cd4dd815b53809b14a3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a47a2e6f4e2607cd4dd815b53809b14a3">◆ </a></span>Get()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static const <a class="el" href="classnnvm_1_1Op.html">Op</a>* nnvm::Op::Get </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>op_name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get an <a class="el" href="classnnvm_1_1Op.html" title="Operator structure.">Op</a> for a given operator name. Will raise an error if the op has not been registered. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">op_name</td><td>Name of the operator. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Pointer to a <a class="el" href="classnnvm_1_1Op.html" title="Operator structure.">Op</a>, valid throughout program lifetime. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a97b65edf5226493f41f4a81e13e6abec"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a97b65edf5226493f41f4a81e13e6abec">◆ </a></span>GetAttr()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classnnvm_1_1OpMap.html">OpMap</a>< ValueType > & nnvm::Op::GetAttr </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>attr_name</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"> |
| |
| <p>Get additional registered attribute about operators. If nothing has been registered, an empty <a class="el" href="classnnvm_1_1OpMap.html" title="A map data structure that takes Op* as key and returns ValueType.">OpMap</a> will be returned. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">attr_name</td><td>The name of the attribute. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="classnnvm_1_1OpMap.html" title="A map data structure that takes Op* as key and returns ValueType.">OpMap</a> of specified attr_name. </dd></dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">ValueType</td><td>The type of the attribute. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ac1f00108da268063c4b14f63f73af92a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac1f00108da268063c4b14f63f73af92a">◆ </a></span>include()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Op.html">Op</a>& nnvm::Op::include </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>group_name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Include all the attributes from an registered op group. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">group_name</td><td>The name of the group. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self.</dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="op_8h.html#af0e87dbf2cd566db02e76ea77f14f20b" title="Register attribute to a group of operators. These attributes will be registered to Op that include th...">NNVM_REGISTER_OP_GROUP</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a6ddb1adaac8e03ae1f66fc41ca927224"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6ddb1adaac8e03ae1f66fc41ca927224">◆ </a></span>set_attr()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Op.html">Op</a> & nnvm::Op::set_attr </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>attr_name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const ValueType & </td> |
| <td class="paramname"><em>value</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>plevel</em> = <code>10</code> </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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Register additional attributes to operator. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">attr_name</td><td>The name of the attribute. </td></tr> |
| <tr><td class="paramname">value</td><td>The value to be set. </td></tr> |
| <tr><td class="paramname">plevel</td><td>The priority level of this set, an higher priority level attribute will replace lower priority level attribute. Must be bigger than 0.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>Cannot set with same plevel twice in the code.</p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">ValueType</td><td>The type of the value to be set. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a3af40f342a817a47f1fb7769ab0866ea"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3af40f342a817a47f1fb7769ab0866ea">◆ </a></span>set_attr_parser()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Op.html">Op</a> & nnvm::Op::set_attr_parser </td> |
| <td>(</td> |
| <td class="paramtype">std::function< void(<a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a> *attrs)> </td> |
| <td class="paramname"><em>fn</em></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"> |
| |
| <p>Set the attr_parser function. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fn</td><td>The number of outputs to be set. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aab25f32ae369dc760f73ca75caa17f2d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aab25f32ae369dc760f73ca75caa17f2d">◆ </a></span>set_num_inputs() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Op.html">Op</a> & nnvm::Op::set_num_inputs </td> |
| <td>(</td> |
| <td class="paramtype">std::function< uint32_t(const <a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a> &attr)> </td> |
| <td class="paramname"><em>fn</em></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"> |
| |
| <p>Set the get_num_outputs function. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fn</td><td>The function to be set. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a2db3c272965df71f1e592ea30a1c824a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2db3c272965df71f1e592ea30a1c824a">◆ </a></span>set_num_inputs() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Op.html">Op</a> & nnvm::Op::set_num_inputs </td> |
| <td>(</td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>n</em></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"> |
| |
| <p>Set the num_inputs. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">n</td><td>The number of inputs to be set. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa7b1b4661e24f8d9ca02c13443cbf6b6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa7b1b4661e24f8d9ca02c13443cbf6b6">◆ </a></span>set_num_outputs() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Op.html">Op</a> & nnvm::Op::set_num_outputs </td> |
| <td>(</td> |
| <td class="paramtype">std::function< uint32_t(const <a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a> &attr)> </td> |
| <td class="paramname"><em>fn</em></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"> |
| |
| <p>Set the get_num_outputs function. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fn</td><td>The function to be set. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a034baf61a5f396d400073433e92bea51"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a034baf61a5f396d400073433e92bea51">◆ </a></span>set_num_outputs() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Op.html">Op</a> & nnvm::Op::set_num_outputs </td> |
| <td>(</td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>n</em></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"> |
| |
| <p>Set the num_outputs. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">n</td><td>The number of outputs to be set. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa9ec331b85b57d31951c4bd3ff8a1473"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa9ec331b85b57d31951c4bd3ff8a1473">◆ </a></span>set_support_level()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Op.html">Op</a> & nnvm::Op::set_support_level </td> |
| <td>(</td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>level</em></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"> |
| |
| <p>Set the support level of op. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">level</td><td>The support level. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Friends And Related Function Documentation</h2> |
| <a id="ac27d3a3a32f9258272ec64e446b539eb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac27d3a3a32f9258272ec64e446b539eb">◆ </a></span>dmlc::Registry< Op ></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">friend class <a class="el" href="classdmlc_1_1Registry.html">dmlc::Registry</a>< <a class="el" href="classnnvm_1_1Op.html">Op</a> ></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="aa78b2abaef315001da64cae7a8050e61"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa78b2abaef315001da64cae7a8050e61">◆ </a></span>OpGroup</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">friend class <a class="el" href="classnnvm_1_1OpGroup.html">OpGroup</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="afcf7d46a60dd033ce159ceceec21db70"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afcf7d46a60dd033ce159ceceec21db70">◆ </a></span>OpMap</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">friend class <a class="el" href="classnnvm_1_1OpMap.html">OpMap</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a8d63a704ebbd55974b66e6efd75b3722"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8d63a704ebbd55974b66e6efd75b3722">◆ </a></span>arguments</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<ParamFieldInfo> nnvm::Op::arguments</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a7781df54dc846bee7d847638e675b959"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7781df54dc846bee7d847638e675b959">◆ </a></span>attr_parser</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::function<void(<a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a>* attrs)> nnvm::Op::attr_parser = nullptr</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Attribute parser to parse the <a class="el" href="structnnvm_1_1NodeAttrs.html" title="The attributes of the current operation node. Usually are additional parameters like axis,...">NodeAttrs</a> information. </p> |
| <p>This can help to get quick access to a parsed attribute object</p> |
| <div class="fragment"><div class="line"><span class="comment">// Example usage of attr_parser.</span></div> |
| <div class="line"> </div> |
| <div class="line"><span class="comment">// Suppose we want to register operator sum.</span></div> |
| <div class="line"><span class="comment">// The parameters about sum operator</span></div> |
| <div class="line"><span class="keyword">struct </span>SumParam {</div> |
| <div class="line"> <span class="keywordtype">int</span> axis;</div> |
| <div class="line">};</div> |
| <div class="line"><span class="comment">// The parser function</span></div> |
| <div class="line"><span class="keywordtype">void</span> SumAttrParser(NodeAttrs* attrs) {</div> |
| <div class="line"> <span class="comment">// This will be invoked during node construction.</span></div> |
| <div class="line"> SumParam param;</div> |
| <div class="line"> <span class="comment">// parse axis string to integer</span></div> |
| <div class="line"> param.axis = atoi(attrs->dict[<span class="stringliteral">"axis"</span>].c_str());</div> |
| <div class="line"> <span class="comment">// set the parsed parameter</span></div> |
| <div class="line"> attrs->parsed = std::move(param);</div> |
| <div class="line">}</div> |
| <div class="line"><span class="comment">// The other function that can utilize the parsed result.</span></div> |
| <div class="line">TShape SumInferShape(<span class="keyword">const</span> NodeAttrs& attrs,</div> |
| <div class="line"> <span class="keyword">const</span> std::vector<TShape>& ishapes) {</div> |
| <div class="line"> <span class="comment">// we can use the parsed version of param</span></div> |
| <div class="line"> <span class="comment">// without repeatively parsing the parameter</span></div> |
| <div class="line"> <span class="keyword">const</span> SumParam& param = nnvm::get<SumParam>(attrs.parsed);</div> |
| <div class="line">}</div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a9552f756aa56608379096b6ca727ccf5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9552f756aa56608379096b6ca727ccf5">◆ </a></span>description</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string nnvm::Op::description</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>detailed description of the operator This can be used to generate docstring automatically for the operator. </p> |
| |
| </div> |
| </div> |
| <a id="aaed55d545403aca8cd4fff730c40e4bd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaed55d545403aca8cd4fff730c40e4bd">◆ </a></span>get_num_inputs</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::function<uint32_t(const <a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a>& attrs)> nnvm::Op::get_num_inputs = nullptr</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>get number of inputs given information about the node. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">attrs</td><td>The attribute of the node </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>number of inputs </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a676849f49f99c9a299d5c50cf00f3b5b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a676849f49f99c9a299d5c50cf00f3b5b">◆ </a></span>get_num_outputs</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::function<uint32_t(const <a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a>& attrs)> nnvm::Op::get_num_outputs = nullptr</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>get number of outputs given information about the node. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">attrs</td><td>The attribute of the node </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>number of outputs. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="af67a5d6998765023aeed6761df292b6c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af67a5d6998765023aeed6761df292b6c">◆ </a></span>name</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string nnvm::Op::name</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>name of the operator </p> |
| |
| </div> |
| </div> |
| <a id="a040c73b911bfb98b3ea9ebc71deed112"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a040c73b911bfb98b3ea9ebc71deed112">◆ </a></span>num_inputs</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint32_t nnvm::Op::num_inputs = 1</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>number of inputs to the operator, -1 means it is variable length When get_num_inputs is presented, the number will be decided by get_num_inputs instead. </p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="classnnvm_1_1Op.html#aaed55d545403aca8cd4fff730c40e4bd" title="get number of inputs given information about the node.">get_num_inputs</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a69435cb4f8b3187a98e938a66d31a610"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a69435cb4f8b3187a98e938a66d31a610">◆ </a></span>num_outputs</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint32_t nnvm::Op::num_outputs = 1</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>number of outputs of the operator When get_num_outputs is presented. The number of outputs will be decided by get_num_outputs function </p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="classnnvm_1_1Op.html#a676849f49f99c9a299d5c50cf00f3b5b" title="get number of outputs given information about the node.">get_num_outputs</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="af9ca45839dffc509576b193683dcfc1c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af9ca45839dffc509576b193683dcfc1c">◆ </a></span>support_level</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint32_t nnvm::Op::support_level = 10</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>support level of the operator, The lower the more priority it contains. This is in analogies to BLAS levels. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/3rdparty/tvm/nnvm/include/nnvm/<a class="el" href="op_8h_source.html">op.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <div class="ttc" id="aclassnnvm_1_1Op_html_ac1f00108da268063c4b14f63f73af92a"><div class="ttname"><a href="classnnvm_1_1Op.html#ac1f00108da268063c4b14f63f73af92a">nnvm::Op::include</a></div><div class="ttdeci">Op & include(const std::string &group_name)</div><div class="ttdoc">Include all the attributes from an registered op group.</div></div> |
| <div class="ttc" id="anamespacennvm_html_ae80cd6cc2432e36350ad84335d5e5308"><div class="ttname"><a href="namespacennvm.html#ae80cd6cc2432e36350ad84335d5e5308">nnvm::FInferShape</a></div><div class="ttdeci">FInferNodeEntryAttr< TShape > FInferShape</div><div class="ttdoc">Shape inference function. Update the shapes given the input shape information. TShape....</div><div class="ttdef"><b>Definition:</b> op_attr_types.h:116</div></div> |
| <div class="ttc" id="aclassnnvm_1_1Op_html_a47a2e6f4e2607cd4dd815b53809b14a3"><div class="ttname"><a href="classnnvm_1_1Op.html#a47a2e6f4e2607cd4dd815b53809b14a3">nnvm::Op::Get</a></div><div class="ttdeci">static const Op * Get(const std::string &op_name)</div><div class="ttdoc">Get an Op for a given operator name. Will raise an error if the op has not been registered.</div></div> |
| <div class="ttc" id="anamespacemxnet_html_ac2fb286fd7ddfbc7af1456f6c7a7ee52"><div class="ttname"><a href="namespacemxnet.html#ac2fb286fd7ddfbc7af1456f6c7a7ee52">mxnet::Op</a></div><div class="ttdeci">nnvm::Op Op</div><div class="ttdoc">operator structure from NNVM</div><div class="ttdef"><b>Definition:</b> base.h:87</div></div> |
| <div class="ttc" id="aop_8h_html_af0e87dbf2cd566db02e76ea77f14f20b"><div class="ttname"><a href="op_8h.html#af0e87dbf2cd566db02e76ea77f14f20b">NNVM_REGISTER_OP_GROUP</a></div><div class="ttdeci">#define NNVM_REGISTER_OP_GROUP(GroupName)</div><div class="ttdoc">Register attribute to a group of operators. These attributes will be registered to Op that include th...</div><div class="ttdef"><b>Definition:</b> op.h:429</div></div> |
| <div class="ttc" id="aop_8h_html_aacfc49292e41582dd1bba725ece160ae"><div class="ttname"><a href="op_8h.html#aacfc49292e41582dd1bba725ece160ae">NNVM_REGISTER_OP</a></div><div class="ttdeci">#define NNVM_REGISTER_OP(OpName)</div><div class="ttdoc">Register a new operator, or set attribute of the corresponding op.</div><div class="ttdef"><b>Definition:</b> op.h:404</div></div> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:41 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |