| <!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.11"/> |
| <title>mxnet: nnvm::Symbol 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> |
| <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 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.11 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="modules.html"><span>Modules</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </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_1Symbol.html">Symbol</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <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="classnnvm_1_1Symbol-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">nnvm::Symbol Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="classnnvm_1_1Symbol.html" title="Symbol is help class used to represent the operator node in Graph. ">Symbol</a> is help class used to represent the operator node in <a class="el" href="classnnvm_1_1Graph.html" title="Symbolic computation graph. This is the intermediate representation for optimization pass...">Graph</a>. |
| <a href="classnnvm_1_1Symbol.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="symbolic_8h_source.html">symbolic.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for nnvm::Symbol:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classnnvm_1_1Symbol__coll__graph.png" border="0" usemap="#nnvm_1_1Symbol_coll__map" alt="Collaboration graph"/></div> |
| <map name="nnvm_1_1Symbol_coll__map" id="nnvm_1_1Symbol_coll__map"> |
| </map> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:a5c3e1cd05b0c8ded96089dd5a5084b65"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a5c3e1cd05b0c8ded96089dd5a5084b65">ListAttrOption</a> { <a class="el" href="classnnvm_1_1Symbol.html#a5c3e1cd05b0c8ded96089dd5a5084b65a276e33da54d3709ceffd6488c32887ea">kRecursive</a> = 0, |
| <a class="el" href="classnnvm_1_1Symbol.html#a5c3e1cd05b0c8ded96089dd5a5084b65a501178e6b2c2f071eb66b2c89c0350e0">kShallow</a> = 1 |
| }<tr class="memdesc:a5c3e1cd05b0c8ded96089dd5a5084b65"><td class="mdescLeft"> </td><td class="mdescRight">option passed to ListAttr <a href="classnnvm_1_1Symbol.html#a5c3e1cd05b0c8ded96089dd5a5084b65">More...</a><br /></td></tr> |
| </td></tr> |
| <tr class="separator:a5c3e1cd05b0c8ded96089dd5a5084b65"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa67db17bfcc319dc42fbe3735a12340e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#aa67db17bfcc319dc42fbe3735a12340e">ListInputOption</a> { <a class="el" href="classnnvm_1_1Symbol.html#aa67db17bfcc319dc42fbe3735a12340ea7befb74f517857a375cbbef311c75ca0">kAll</a> = 0, |
| <a class="el" href="classnnvm_1_1Symbol.html#aa67db17bfcc319dc42fbe3735a12340eaf8cc6abf2439fac5caddc634ff2f31b3">kReadOnlyArgs</a> = 1, |
| <a class="el" href="classnnvm_1_1Symbol.html#aa67db17bfcc319dc42fbe3735a12340ea04c779ddbed8e8ad5ebe9d36b2244773">kAuxiliaryStates</a> = 2 |
| }<tr class="memdesc:aa67db17bfcc319dc42fbe3735a12340e"><td class="mdescLeft"> </td><td class="mdescRight">option passed to ListInputNames <a href="classnnvm_1_1Symbol.html#aa67db17bfcc319dc42fbe3735a12340e">More...</a><br /></td></tr> |
| </td></tr> |
| <tr class="separator:aa67db17bfcc319dc42fbe3735a12340e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:a2f6dcf0e6b5d3a97733c85fad54b1e75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a2f6dcf0e6b5d3a97733c85fad54b1e75">Copy</a> () const </td></tr> |
| <tr class="memdesc:a2f6dcf0e6b5d3a97733c85fad54b1e75"><td class="mdescLeft"> </td><td class="mdescRight">Copy the symbol. <a href="#a2f6dcf0e6b5d3a97733c85fad54b1e75">More...</a><br /></td></tr> |
| <tr class="separator:a2f6dcf0e6b5d3a97733c85fad54b1e75"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aba10bff2b4862702a989d092b5f62645"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#aba10bff2b4862702a989d092b5f62645">Print</a> (std::ostream &os) const </td></tr> |
| <tr class="memdesc:aba10bff2b4862702a989d092b5f62645"><td class="mdescLeft"> </td><td class="mdescRight">Print the symbol info to output stream. <a href="#aba10bff2b4862702a989d092b5f62645">More...</a><br /></td></tr> |
| <tr class="separator:aba10bff2b4862702a989d092b5f62645"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7d08ae8a7016506234865c6568361718"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a7d08ae8a7016506234865c6568361718">operator[]</a> (size_t index) const </td></tr> |
| <tr class="memdesc:a7d08ae8a7016506234865c6568361718"><td class="mdescLeft"> </td><td class="mdescRight">Get the index-th element from the returned tuple. <a href="#a7d08ae8a7016506234865c6568361718">More...</a><br /></td></tr> |
| <tr class="separator:a7d08ae8a7016506234865c6568361718"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4d5e2f83681476d3d2006faa8224e3ea"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="namespacennvm.html#a4259d4f89d9f0feb94111a1c8cb5a1ae">NodePtr</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a4d5e2f83681476d3d2006faa8224e3ea">ListInputs</a> (<a class="el" href="classnnvm_1_1Symbol.html#aa67db17bfcc319dc42fbe3735a12340e">ListInputOption</a> option) const </td></tr> |
| <tr class="memdesc:a4d5e2f83681476d3d2006faa8224e3ea"><td class="mdescLeft"> </td><td class="mdescRight">List the input variable nodes. <a href="#a4d5e2f83681476d3d2006faa8224e3ea">More...</a><br /></td></tr> |
| <tr class="separator:a4d5e2f83681476d3d2006faa8224e3ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1379b3d8479f48cd77cf454e7f7f1b5a"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a1379b3d8479f48cd77cf454e7f7f1b5a">ListInputNames</a> (<a class="el" href="classnnvm_1_1Symbol.html#aa67db17bfcc319dc42fbe3735a12340e">ListInputOption</a> option) const </td></tr> |
| <tr class="memdesc:a1379b3d8479f48cd77cf454e7f7f1b5a"><td class="mdescLeft"> </td><td class="mdescRight">List the input names. <a href="#a1379b3d8479f48cd77cf454e7f7f1b5a">More...</a><br /></td></tr> |
| <tr class="separator:a1379b3d8479f48cd77cf454e7f7f1b5a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a541094ef1f249843d9060da8bd14a239"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a541094ef1f249843d9060da8bd14a239">ListOutputNames</a> () const </td></tr> |
| <tr class="memdesc:a541094ef1f249843d9060da8bd14a239"><td class="mdescLeft"> </td><td class="mdescRight">List the names of outputs for this symbol. <a href="#a541094ef1f249843d9060da8bd14a239">More...</a><br /></td></tr> |
| <tr class="separator:a541094ef1f249843d9060da8bd14a239"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae1c35c3de7bec49b46af472718885913"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#ae1c35c3de7bec49b46af472718885913">Compose</a> (const <a class="el" href="classdmlc_1_1array__view.html">array_view</a>< const <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> * > &args, const std::unordered_map< std::string, const <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> * > &kwargs, const std::string &name)</td></tr> |
| <tr class="memdesc:ae1c35c3de7bec49b46af472718885913"><td class="mdescLeft"> </td><td class="mdescRight">Compose the symbol with arguments, this changes the current symbol. The kwargs passed in can be in-complete,. <a href="#ae1c35c3de7bec49b46af472718885913">More...</a><br /></td></tr> |
| <tr class="separator:ae1c35c3de7bec49b46af472718885913"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af266ed0d726bf258512f1c60a3ac5689"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#af266ed0d726bf258512f1c60a3ac5689">operator()</a> (const <a class="el" href="classdmlc_1_1array__view.html">array_view</a>< const <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> * > &args, const std::unordered_map< std::string, const <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> * > &kwargs, const std::string &name) const </td></tr> |
| <tr class="memdesc:af266ed0d726bf258512f1c60a3ac5689"><td class="mdescLeft"> </td><td class="mdescRight">Apply the symbol as a function, compose with arguments. <a href="#af266ed0d726bf258512f1c60a3ac5689">More...</a><br /></td></tr> |
| <tr class="separator:af266ed0d726bf258512f1c60a3ac5689"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a12b3cb331bbedf99b72933e492da01c0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a12b3cb331bbedf99b72933e492da01c0">AddControlDeps</a> (const <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> &src)</td></tr> |
| <tr class="memdesc:a12b3cb331bbedf99b72933e492da01c0"><td class="mdescLeft"> </td><td class="mdescRight">Add control flow dependencies to the operators in symbols. <a href="#a12b3cb331bbedf99b72933e492da01c0">More...</a><br /></td></tr> |
| <tr class="separator:a12b3cb331bbedf99b72933e492da01c0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a11e5d8a9144c24ea9330f3484aa3f8f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a11e5d8a9144c24ea9330f3484aa3f8f2">GetInternals</a> () const </td></tr> |
| <tr class="separator:a11e5d8a9144c24ea9330f3484aa3f8f2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a604f68c36b51206ea88113acb0487b3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a604f68c36b51206ea88113acb0487b3d">GetChildren</a> () const </td></tr> |
| <tr class="separator:a604f68c36b51206ea88113acb0487b3d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0b1a772a70703aebca928ad728b9ca14"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a0b1a772a70703aebca928ad728b9ca14">SetAttrs</a> (const std::vector< std::pair< std::string, std::string > > &attrs)</td></tr> |
| <tr class="memdesc:a0b1a772a70703aebca928ad728b9ca14"><td class="mdescLeft"> </td><td class="mdescRight">Set additional attributes to current node. <a href="#a0b1a772a70703aebca928ad728b9ca14">More...</a><br /></td></tr> |
| <tr class="separator:a0b1a772a70703aebca928ad728b9ca14"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a78f63137130882160ef05d36fbd7a174"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a78f63137130882160ef05d36fbd7a174">GetAttr</a> (const std::string &key, std::string *out) const </td></tr> |
| <tr class="memdesc:a78f63137130882160ef05d36fbd7a174"><td class="mdescLeft"> </td><td class="mdescRight">Get attributes from the symbol. <a href="#a78f63137130882160ef05d36fbd7a174">More...</a><br /></td></tr> |
| <tr class="separator:a78f63137130882160ef05d36fbd7a174"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5235c18d1f91d8b36d93fee2908d99a5"><td class="memItemLeft" align="right" valign="top">std::unordered_map< std::string, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a5235c18d1f91d8b36d93fee2908d99a5">ListAttrs</a> (<a class="el" href="classnnvm_1_1Symbol.html#a5c3e1cd05b0c8ded96089dd5a5084b65">ListAttrOption</a> option) const </td></tr> |
| <tr class="memdesc:a5235c18d1f91d8b36d93fee2908d99a5"><td class="mdescLeft"> </td><td class="mdescRight">Get attribute dictionary from the symbol. <a href="#a5235c18d1f91d8b36d93fee2908d99a5">More...</a><br /></td></tr> |
| <tr class="separator:a5235c18d1f91d8b36d93fee2908d99a5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a60280f79c99dd237a108523b3c2760ac"><td class="memItemLeft" align="right" valign="top">std::vector< std::tuple< std::string, std::string, std::string > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#a60280f79c99dd237a108523b3c2760ac">ListAttrsRecursive</a> () const </td></tr> |
| <tr class="memdesc:a60280f79c99dd237a108523b3c2760ac"><td class="mdescLeft"> </td><td class="mdescRight">Get attribute dictionary from the symbol and all children. <a href="#a60280f79c99dd237a108523b3c2760ac">More...</a><br /></td></tr> |
| <tr class="separator:a60280f79c99dd237a108523b3c2760ac"><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:ad68fe3762d1c142468006009a313a257"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#ad68fe3762d1c142468006009a313a257">CreateFunctor</a> (const <a class="el" href="classnnvm_1_1Op.html">Op</a> *op, std::unordered_map< std::string, std::string > attrs)</td></tr> |
| <tr class="memdesc:ad68fe3762d1c142468006009a313a257"><td class="mdescLeft"> </td><td class="mdescRight">Create symbolic functor(AtomicSymbol) by given operator and attributes. <a href="#ad68fe3762d1c142468006009a313a257">More...</a><br /></td></tr> |
| <tr class="separator:ad68fe3762d1c142468006009a313a257"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac6de1c6d975cd700df7b4ba226ebd1cf"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#ac6de1c6d975cd700df7b4ba226ebd1cf">CreateFunctor</a> (const <a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a> &attrs)</td></tr> |
| <tr class="memdesc:ac6de1c6d975cd700df7b4ba226ebd1cf"><td class="mdescLeft"> </td><td class="mdescRight">Create symbolic functor(AtomicSymbol) by given node attributes. <a href="#ac6de1c6d975cd700df7b4ba226ebd1cf">More...</a><br /></td></tr> |
| <tr class="separator:ac6de1c6d975cd700df7b4ba226ebd1cf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab5c2dec39caca4c736b3e3bdc2b1152c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#ab5c2dec39caca4c736b3e3bdc2b1152c">CreateVariable</a> (const std::string &name)</td></tr> |
| <tr class="memdesc:ab5c2dec39caca4c736b3e3bdc2b1152c"><td class="mdescLeft"> </td><td class="mdescRight">Create symbol node representing variable. <a href="#ab5c2dec39caca4c736b3e3bdc2b1152c">More...</a><br /></td></tr> |
| <tr class="separator:ab5c2dec39caca4c736b3e3bdc2b1152c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa7cbc81fa9d1d1336b89d3bee3200e9b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#aa7cbc81fa9d1d1336b89d3bee3200e9b">CreateGroup</a> (const std::vector< <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> > &symbols)</td></tr> |
| <tr class="memdesc:aa7cbc81fa9d1d1336b89d3bee3200e9b"><td class="mdescLeft"> </td><td class="mdescRight">Create equivalence of symbol by grouping the symbols together. <a href="#aa7cbc81fa9d1d1336b89d3bee3200e9b">More...</a><br /></td></tr> |
| <tr class="separator:aa7cbc81fa9d1d1336b89d3bee3200e9b"><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:ae274e2f7479e0d90cefd3a4481c9cbf2"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="structnnvm_1_1NodeEntry.html">NodeEntry</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Symbol.html#ae274e2f7479e0d90cefd3a4481c9cbf2">outputs</a></td></tr> |
| <tr class="memdesc:ae274e2f7479e0d90cefd3a4481c9cbf2"><td class="mdescLeft"> </td><td class="mdescRight">output entries contained in the symbol <a href="#ae274e2f7479e0d90cefd3a4481c9cbf2">More...</a><br /></td></tr> |
| <tr class="separator:ae274e2f7479e0d90cefd3a4481c9cbf2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="classnnvm_1_1Symbol.html" title="Symbol is help class used to represent the operator node in Graph. ">Symbol</a> is help class used to represent the operator node in <a class="el" href="classnnvm_1_1Graph.html" title="Symbolic computation graph. This is the intermediate representation for optimization pass...">Graph</a>. </p> |
| <p><a class="el" href="classnnvm_1_1Symbol.html" title="Symbol is help class used to represent the operator node in Graph. ">Symbol</a> acts as an interface for building graphs from different components like Variable, Functor and Group. <a class="el" href="classnnvm_1_1Symbol.html" title="Symbol is help class used to represent the operator node in Graph. ">Symbol</a> is also exported to python front-end (while <a class="el" href="classnnvm_1_1Graph.html" title="Symbolic computation graph. This is the intermediate representation for optimization pass...">Graph</a> is not) to enable quick test and deployment. Conceptually, symbol is the final operation of a graph and thus including all the information required (the graph) to evaluate its output value. </p> |
| </div><h2 class="groupheader">Member Enumeration Documentation</h2> |
| <a class="anchor" id="a5c3e1cd05b0c8ded96089dd5a5084b65"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="classnnvm_1_1Symbol.html#a5c3e1cd05b0c8ded96089dd5a5084b65">nnvm::Symbol::ListAttrOption</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>option passed to ListAttr </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a5c3e1cd05b0c8ded96089dd5a5084b65a276e33da54d3709ceffd6488c32887ea"></a>kRecursive </td><td class="fielddoc"> |
| <p>recursively list all attributes </p> |
| </td></tr> |
| <tr><td class="fieldname"><a class="anchor" id="a5c3e1cd05b0c8ded96089dd5a5084b65a501178e6b2c2f071eb66b2c89c0350e0"></a>kShallow </td><td class="fielddoc"> |
| <p>only list attributes in current node </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa67db17bfcc319dc42fbe3735a12340e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="classnnvm_1_1Symbol.html#aa67db17bfcc319dc42fbe3735a12340e">nnvm::Symbol::ListInputOption</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>option passed to ListInputNames </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="aa67db17bfcc319dc42fbe3735a12340ea7befb74f517857a375cbbef311c75ca0"></a>kAll </td><td class="fielddoc"> |
| <p>list all the arguments </p> |
| </td></tr> |
| <tr><td class="fieldname"><a class="anchor" id="aa67db17bfcc319dc42fbe3735a12340eaf8cc6abf2439fac5caddc634ff2f31b3"></a>kReadOnlyArgs </td><td class="fielddoc"> |
| <p>list only read only arguments </p> |
| </td></tr> |
| <tr><td class="fieldname"><a class="anchor" id="aa67db17bfcc319dc42fbe3735a12340ea04c779ddbed8e8ad5ebe9d36b2244773"></a>kAuxiliaryStates </td><td class="fielddoc"> |
| <p>List auxiliary states that can be mutated by the graph. This excludes the ReadOnly arguments. </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a12b3cb331bbedf99b72933e492da01c0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void nnvm::Symbol::AddControlDeps </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> & </td> |
| <td class="paramname"><em>src</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add control flow dependencies to the operators in symbols. </p> |
| <p>For grouped symbol, an error will be raised. This mutates current symbolic <a class="el" href="classnnvm_1_1Node.html" title="Node represents an operation in a computation graph. ">Node</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">src</td><td>The symbols to depend on. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae1c35c3de7bec49b46af472718885913"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void nnvm::Symbol::Compose </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classdmlc_1_1array__view.html">array_view</a>< const <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> * > & </td> |
| <td class="paramname"><em>args</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::unordered_map< std::string, const <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> * > & </td> |
| <td class="paramname"><em>kwargs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Compose the symbol with arguments, this changes the current symbol. The kwargs passed in can be in-complete,. </p> |
| <p>The rest of the symbols will remain the same name.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">args</td><td>Positional arguments. </td></tr> |
| <tr><td class="paramname">kwargs</td><td>Keyword arguments for the symbol. </td></tr> |
| <tr><td class="paramname">name</td><td>Name of returned symbol. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2f6dcf0e6b5d3a97733c85fad54b1e75"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> nnvm::Symbol::Copy </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy the symbol. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A deep copy of this symbol. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad68fe3762d1c142468006009a313a257"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> nnvm::Symbol::CreateFunctor </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classnnvm_1_1Op.html">Op</a> * </td> |
| <td class="paramname"><em>op</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::unordered_map< std::string, std::string > </td> |
| <td class="paramname"><em>attrs</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">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create symbolic functor(AtomicSymbol) by given operator and attributes. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">op</td><td>The operator. </td></tr> |
| <tr><td class="paramname">attrs</td><td>The additional attributes. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classnnvm_1_1Symbol.html" title="Symbol is help class used to represent the operator node in Graph. ">Symbol</a> that can be used to call compose further. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac6de1c6d975cd700df7b4ba226ebd1cf"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> nnvm::Symbol::CreateFunctor </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a> & </td> |
| <td class="paramname"><em>attrs</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>Create symbolic functor(AtomicSymbol) by given node attributes. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">attrs</td><td>pre-initialized <a class="el" href="classnnvm_1_1Node.html" title="Node represents an operation in a computation graph. ">Node</a> attributes. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classnnvm_1_1Symbol.html" title="Symbol is help class used to represent the operator node in Graph. ">Symbol</a> that can be used to call compose further. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa7cbc81fa9d1d1336b89d3bee3200e9b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> nnvm::Symbol::CreateGroup </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> > & </td> |
| <td class="paramname"><em>symbols</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>Create equivalence of symbol by grouping the symbols together. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">symbols</td><td>A list of symbols to be grouped. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The grouped symbol. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab5c2dec39caca4c736b3e3bdc2b1152c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> nnvm::Symbol::CreateVariable </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>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>Create symbol node representing variable. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>Name of the variable. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The symbol. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a78f63137130882160ef05d36fbd7a174"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool nnvm::Symbol::GetAttr </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::string * </td> |
| <td class="paramname"><em>out</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get attributes from the symbol. </p> |
| <p>This only works for symbol with outputs from single operators. For grouped symbol, an error will be raised.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>Key of the attribute. When key == "name", it returns the name attirbute. </td></tr> |
| <tr><td class="paramname">out</td><td>The output value of the attribute. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true If the attribute exists, false if the attribute does not exist. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a604f68c36b51206ea88113acb0487b3d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> nnvm::Symbol::GetChildren </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a11e5d8a9144c24ea9330f3484aa3f8f2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> nnvm::Symbol::GetInternals </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5235c18d1f91d8b36d93fee2908d99a5"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::unordered_map<std::string, std::string> nnvm::Symbol::ListAttrs </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classnnvm_1_1Symbol.html#a5c3e1cd05b0c8ded96089dd5a5084b65">ListAttrOption</a> </td> |
| <td class="paramname"><em>option</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get attribute dictionary from the symbol. </p> |
| <p>For grouped symbol, an error will be raised.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">option</td><td>If recursive flag is set, the attributes of all children are retrieved. The name of symbol will be pre-pended to each key. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The created attribute. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a60280f79c99dd237a108523b3c2760ac"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<std::tuple<std::string, std::string, std::string> > nnvm::Symbol::ListAttrsRecursive </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get attribute dictionary from the symbol and all children. </p> |
| <p>For grouped symbol, an error will be raised.</p> |
| <dl class="section return"><dt>Returns</dt><dd>The created attribute in format <operator_name, key, value>. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1379b3d8479f48cd77cf454e7f7f1b5a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<std::string> nnvm::Symbol::ListInputNames </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classnnvm_1_1Symbol.html#aa67db17bfcc319dc42fbe3735a12340e">ListInputOption</a> </td> |
| <td class="paramname"><em>option</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>List the input names. </p> |
| <p>The order of the returned list is the same as the order of the input list to <code>operator()</code>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">option</td><td>The options to list the arguments. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The arguments list of this symbol, they can be either named or unnamed (empty string). </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="classnnvm_1_1Symbol.html#aa67db17bfcc319dc42fbe3735a12340e" title="option passed to ListInputNames ">ListInputOption</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4d5e2f83681476d3d2006faa8224e3ea"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<<a class="el" href="namespacennvm.html#a4259d4f89d9f0feb94111a1c8cb5a1ae">NodePtr</a>> nnvm::Symbol::ListInputs </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classnnvm_1_1Symbol.html#aa67db17bfcc319dc42fbe3735a12340e">ListInputOption</a> </td> |
| <td class="paramname"><em>option</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>List the input variable nodes. </p> |
| <p>The order of the returned list is the same as the order of the input list to <code>operator()</code>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">option</td><td>The options to list the arguments. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The arguments list of this symbol, they can be either named or unnamed (empty string). </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="classnnvm_1_1Symbol.html#aa67db17bfcc319dc42fbe3735a12340e" title="option passed to ListInputNames ">ListInputOption</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a541094ef1f249843d9060da8bd14a239"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<std::string> nnvm::Symbol::ListOutputNames </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>List the names of outputs for this symbol. </p> |
| <p>For normal operators, it is usually symbol node name + "_output".</p> |
| <dl class="section return"><dt>Returns</dt><dd>get the descriptions of outputs for this symbol. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af266ed0d726bf258512f1c60a3ac5689"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> nnvm::Symbol::operator() </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classdmlc_1_1array__view.html">array_view</a>< const <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> * > & </td> |
| <td class="paramname"><em>args</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::unordered_map< std::string, const <a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> * > & </td> |
| <td class="paramname"><em>kwargs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Apply the symbol as a function, compose with arguments. </p> |
| <p>This is equivalent to Copy then Compose.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">args</td><td>Positional arguments for the symbol. </td></tr> |
| <tr><td class="paramname">kwargs</td><td>Keyword arguments for the symbol. </td></tr> |
| <tr><td class="paramname">name</td><td>Name of returned symbol. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classnnvm_1_1Symbol.html" title="Symbol is help class used to represent the operator node in Graph. ">Symbol</a> which is the composition of current symbol with its arguments. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7d08ae8a7016506234865c6568361718"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classnnvm_1_1Symbol.html">Symbol</a> nnvm::Symbol::operator[] </td> |
| <td>(</td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>index</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the index-th element from the returned tuple. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">index</td><td>Index of multi output. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The symbol corresponds to the indexed element. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aba10bff2b4862702a989d092b5f62645"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void nnvm::Symbol::Print </td> |
| <td>(</td> |
| <td class="paramtype">std::ostream & </td> |
| <td class="paramname"><em>os</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Print the symbol info to output stream. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">os</td><td>The output stream to print to. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0b1a772a70703aebca928ad728b9ca14"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void nnvm::Symbol::SetAttrs </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< std::pair< std::string, std::string > > & </td> |
| <td class="paramname"><em>attrs</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set additional attributes to current node. </p> |
| <p>This only works for symbol with outputs from single operators. For grouped symbol, an error will be raised.</p> |
| <p>This function mutates the node's symbol and is not recommended.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">attrs</td><td>The attributes to set. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="ae274e2f7479e0d90cefd3a4481c9cbf2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<<a class="el" href="structnnvm_1_1NodeEntry.html">NodeEntry</a>> nnvm::Symbol::outputs</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>output entries contained in the symbol </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="symbolic_8h_source.html">symbolic.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Sat Mar 28 2020 00:52:32 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.11 |
| </small></address> |
| </body> |
| </html> |