| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: mxnet::OpContext Struct Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="structmxnet_1_1OpContext.html">OpContext</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="structmxnet_1_1OpContext-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::OpContext Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>All the possible information needed by <a class="el" href="classmxnet_1_1Operator.html#a3dbe23d985df86da51eeb868439872dd" title="perform a forward operation of Operator, save the output to TBlob. ">Operator.Forward</a> and Backward This is the superset of <a class="el" href="structmxnet_1_1RunContext.html" title="execution time context. The information needed in runtime for actual execution. ">RunContext</a>. We use this data structure to bookkeep everything needed by Forward and Backward. |
| <a href="structmxnet_1_1OpContext.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="include_2mxnet_2op__attr__types_8h_source.html">op_attr_types.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::OpContext:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="structmxnet_1_1OpContext__coll__graph.png" border="0" usemap="#mxnet_1_1OpContext_coll__map" alt="Collaboration graph"/></div> |
| <map name="mxnet_1_1OpContext_coll__map" id="mxnet_1_1OpContext_coll__map"> |
| <area shape="rect" id="node2" href="structmxnet_1_1RunContext.html" title="execution time context. The information needed in runtime for actual execution. " alt="" coords="27,439,210,575"/> |
| <area shape="rect" id="node3" href="structmxnet_1_1Context.html" title="Context information about the execution environment. " alt="" coords="5,5,232,376"/> |
| <area shape="rect" id="node4" href="classmxnet_1_1engine_1_1CallbackOnComplete.html" title="OnComplete Callback to the engine, called by AsyncFn when action completes. " alt="" coords="234,461,433,553"/> |
| </map> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a0c48c2419d23551a626ae3de6ee1f6da"><td class="memTemplParams" colspan="2">template<typename xpu > </td></tr> |
| <tr class="memitem:a0c48c2419d23551a626ae3de6ee1f6da"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< xpu > * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structmxnet_1_1OpContext.html#a0c48c2419d23551a626ae3de6ee1f6da">get_stream</a> () const</td></tr> |
| <tr class="memdesc:a0c48c2419d23551a626ae3de6ee1f6da"><td class="mdescLeft"> </td><td class="mdescRight">get mshadow stream from <a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> <a href="#a0c48c2419d23551a626ae3de6ee1f6da">More...</a><br /></td></tr> |
| <tr class="separator:a0c48c2419d23551a626ae3de6ee1f6da"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1c05a1376bc046ff717827643af4974a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1OpContext.html#a1c05a1376bc046ff717827643af4974a">get_gpu_aux_stream</a> () const</td></tr> |
| <tr class="memdesc:a1c05a1376bc046ff717827643af4974a"><td class="mdescLeft"> </td><td class="mdescRight">get auxilary gpu stream auto-syncing object from <a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> <a href="#a1c05a1376bc046ff717827643af4974a">More...</a><br /></td></tr> |
| <tr class="separator:a1c05a1376bc046ff717827643af4974a"><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:adffa555a95b50893b5fe7a2930a71d62"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1OpContext.html#adffa555a95b50893b5fe7a2930a71d62">need_grad</a></td></tr> |
| <tr class="memdesc:adffa555a95b50893b5fe7a2930a71d62"><td class="mdescLeft"> </td><td class="mdescRight">whether there is a backward phase to compute gradients. <a href="#adffa555a95b50893b5fe7a2930a71d62">More...</a><br /></td></tr> |
| <tr class="separator:adffa555a95b50893b5fe7a2930a71d62"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2d550bd138ed08333bebed8dd876644f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1OpContext.html#a2d550bd138ed08333bebed8dd876644f">is_train</a></td></tr> |
| <tr class="memdesc:a2d550bd138ed08333bebed8dd876644f"><td class="mdescLeft"> </td><td class="mdescRight">whether it is training phase <a href="#a2d550bd138ed08333bebed8dd876644f">More...</a><br /></td></tr> |
| <tr class="separator:a2d550bd138ed08333bebed8dd876644f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a869d4c68c0028a175406f11332baf7cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmxnet_1_1RunContext.html">RunContext</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1OpContext.html#a869d4c68c0028a175406f11332baf7cf">run_ctx</a></td></tr> |
| <tr class="memdesc:a869d4c68c0028a175406f11332baf7cf"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structmxnet_1_1RunContext.html" title="execution time context. The information needed in runtime for actual execution. ">RunContext</a> related resources. <a href="#a869d4c68c0028a175406f11332baf7cf">More...</a><br /></td></tr> |
| <tr class="separator:a869d4c68c0028a175406f11332baf7cf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a40ce0e3d4ac21412cfafafc5b1fd32ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1engine_1_1CallbackOnComplete.html">engine::CallbackOnComplete</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1OpContext.html#a40ce0e3d4ac21412cfafafc5b1fd32ef">async_on_complete</a></td></tr> |
| <tr class="memdesc:a40ce0e3d4ac21412cfafafc5b1fd32ef"><td class="mdescLeft"> </td><td class="mdescRight">the callback when operation completes, used by asynchronize ops <a href="#a40ce0e3d4ac21412cfafafc5b1fd32ef">More...</a><br /></td></tr> |
| <tr class="separator:a40ce0e3d4ac21412cfafafc5b1fd32ef"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a833e95f95cf5e3af9c193b74b500fc5b"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="structmxnet_1_1Resource.html">Resource</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1OpContext.html#a833e95f95cf5e3af9c193b74b500fc5b">requested</a></td></tr> |
| <tr class="memdesc:a833e95f95cf5e3af9c193b74b500fc5b"><td class="mdescLeft"> </td><td class="mdescRight">Resources requested by the operator. <a href="#a833e95f95cf5e3af9c193b74b500fc5b">More...</a><br /></td></tr> |
| <tr class="separator:a833e95f95cf5e3af9c193b74b500fc5b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>All the possible information needed by <a class="el" href="classmxnet_1_1Operator.html#a3dbe23d985df86da51eeb868439872dd" title="perform a forward operation of Operator, save the output to TBlob. ">Operator.Forward</a> and Backward This is the superset of <a class="el" href="structmxnet_1_1RunContext.html" title="execution time context. The information needed in runtime for actual execution. ">RunContext</a>. We use this data structure to bookkeep everything needed by Forward and Backward. </p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="structmxnet_1_1Resource.html" title="Resources used by mxnet operations. A resource is something special other than NDArray, but will still participate. ">Resource</a> </dd></dl> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a1c05a1376bc046ff717827643af4974a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1c05a1376bc046ff717827643af4974a">◆ </a></span>get_gpu_aux_stream()</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="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a> mxnet::OpContext::get_gpu_aux_stream </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</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>get auxilary gpu stream auto-syncing object from <a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> </p> |
| <dl class="section return"><dt>Returns</dt><dd>the aux stream auto-syncing object </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a0c48c2419d23551a626ae3de6ee1f6da"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0c48c2419d23551a626ae3de6ee1f6da">◆ </a></span>get_stream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename xpu > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a><xpu>* mxnet::OpContext::get_stream </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</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>get mshadow stream from <a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> </p> |
| <dl class="section return"><dt>Returns</dt><dd>the mshadow stream </dd></dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">xpu</td><td>the device type of the stream </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a40ce0e3d4ac21412cfafafc5b1fd32ef"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a40ce0e3d4ac21412cfafafc5b1fd32ef">◆ </a></span>async_on_complete</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1engine_1_1CallbackOnComplete.html">engine::CallbackOnComplete</a> mxnet::OpContext::async_on_complete</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>the callback when operation completes, used by asynchronize ops </p> |
| |
| </div> |
| </div> |
| <a id="a2d550bd138ed08333bebed8dd876644f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2d550bd138ed08333bebed8dd876644f">◆ </a></span>is_train</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mxnet::OpContext::is_train</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>whether it is training phase </p> |
| |
| </div> |
| </div> |
| <a id="adffa555a95b50893b5fe7a2930a71d62"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adffa555a95b50893b5fe7a2930a71d62">◆ </a></span>need_grad</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mxnet::OpContext::need_grad</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>whether there is a backward phase to compute gradients. </p> |
| |
| </div> |
| </div> |
| <a id="a833e95f95cf5e3af9c193b74b500fc5b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a833e95f95cf5e3af9c193b74b500fc5b">◆ </a></span>requested</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<<a class="el" href="structmxnet_1_1Resource.html">Resource</a>> mxnet::OpContext::requested</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Resources requested by the operator. </p> |
| |
| </div> |
| </div> |
| <a id="a869d4c68c0028a175406f11332baf7cf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a869d4c68c0028a175406f11332baf7cf">◆ </a></span>run_ctx</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structmxnet_1_1RunContext.html">RunContext</a> mxnet::OpContext::run_ctx</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><a class="el" href="structmxnet_1_1RunContext.html" title="execution time context. The information needed in runtime for actual execution. ">RunContext</a> related resources. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>/work/mxnet/include/mxnet/<a class="el" href="include_2mxnet_2op__attr__types_8h_source.html">op_attr_types.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:44 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
