| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: mxnet::ext::OpResource Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1ext.html">ext</a></li><li class="navelem"><a class="el" href="classmxnet_1_1ext_1_1OpResource.html">OpResource</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classmxnet_1_1ext_1_1OpResource-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::ext::OpResource Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>provide resource APIs memory allocation mechanism to Forward/Backward functions |
| <a href="classmxnet_1_1ext_1_1OpResource.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="lib__api_8h_source.html">lib_api.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::ext::OpResource:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1ext_1_1OpResource__coll__graph.png" border="0" usemap="#mxnet_1_1ext_1_1OpResource_coll__map" alt="Collaboration graph"/></div> |
| <map name="mxnet_1_1ext_1_1OpResource_coll__map" id="mxnet_1_1ext_1_1OpResource_coll__map"> |
| </map> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a4e9eb54d2481fcb97231fec20290bd5d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1OpResource.html#a4e9eb54d2481fcb97231fec20290bd5d">OpResource</a> (<a class="el" href="namespacemxnet_1_1ext.html#a6047dc7436d917e950612a84fd912760">xpu_malloc_t</a> cpu_malloc_fp, void *cpu_alloc_fp, <a class="el" href="namespacemxnet_1_1ext.html#a6047dc7436d917e950612a84fd912760">xpu_malloc_t</a> gpu_malloc_fp, void *gpu_alloc_fp, void *stream, <a class="el" href="namespacemxnet_1_1ext.html#a4128a869e7ed8d1ed7c04037d752300e">sparse_malloc_t</a> sparse_malloc_fp, void *sparse_alloc_fp, void *rng_cpu_states, void *rng_gpu_states)</td></tr> |
| <tr class="separator:a4e9eb54d2481fcb97231fec20290bd5d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aca8a01d001adef1481fa5506b76d117b"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1OpResource.html#aca8a01d001adef1481fa5506b76d117b">alloc_cpu</a> (int size) const</td></tr> |
| <tr class="memdesc:aca8a01d001adef1481fa5506b76d117b"><td class="mdescLeft"> </td><td class="mdescRight">allocate cpu memory controlled by MXNet <a href="#aca8a01d001adef1481fa5506b76d117b">More...</a><br /></td></tr> |
| <tr class="separator:aca8a01d001adef1481fa5506b76d117b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9f2d4d97f7d2eb3c492c8f8fcfb98100"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1OpResource.html#a9f2d4d97f7d2eb3c492c8f8fcfb98100">alloc_gpu</a> (int size) const</td></tr> |
| <tr class="memdesc:a9f2d4d97f7d2eb3c492c8f8fcfb98100"><td class="mdescLeft"> </td><td class="mdescRight">allocate gpu memory controlled by MXNet <a href="#a9f2d4d97f7d2eb3c492c8f8fcfb98100">More...</a><br /></td></tr> |
| <tr class="separator:a9f2d4d97f7d2eb3c492c8f8fcfb98100"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a712e78a6c50beca023bc20064688bd1f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemxnet_1_1ext.html#aebb5b6454e5e75b03cafa3ccebf6f752">mx_stream_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1OpResource.html#a712e78a6c50beca023bc20064688bd1f">get_cuda_stream</a> () const</td></tr> |
| <tr class="memdesc:a712e78a6c50beca023bc20064688bd1f"><td class="mdescLeft"> </td><td class="mdescRight">return the cuda stream object with correct type <a href="#a712e78a6c50beca023bc20064688bd1f">More...</a><br /></td></tr> |
| <tr class="separator:a712e78a6c50beca023bc20064688bd1f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a037945db6e2934e1f4acefe2c8337740"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1OpResource.html#a037945db6e2934e1f4acefe2c8337740">alloc_sparse</a> (<a class="el" href="structmxnet_1_1ext_1_1MXSparse.html">MXSparse</a> *sparse, int index, int indices_len, int indptr_len=0) const</td></tr> |
| <tr class="memdesc:a037945db6e2934e1f4acefe2c8337740"><td class="mdescLeft"> </td><td class="mdescRight">allocate sparse memory controlled by MXNet <a href="#a037945db6e2934e1f4acefe2c8337740">More...</a><br /></td></tr> |
| <tr class="separator:a037945db6e2934e1f4acefe2c8337740"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acd1f86bb22908ed80946488bb99c5020"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemxnet_1_1ext.html#acbae2c4272b5ac64651bffbf8f000dd8">mx_cpu_rand_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1OpResource.html#acd1f86bb22908ed80946488bb99c5020">get_cpu_rand_states</a> () const</td></tr> |
| <tr class="memdesc:acd1f86bb22908ed80946488bb99c5020"><td class="mdescLeft"> </td><td class="mdescRight">get pointer to initialized and seeded random number states located on CPU <a href="#acd1f86bb22908ed80946488bb99c5020">More...</a><br /></td></tr> |
| <tr class="separator:acd1f86bb22908ed80946488bb99c5020"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3c75f8ca600930d970e3ea20cd624884"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemxnet_1_1ext.html#a8f6f2a2bef8d1c2ca135ed4137673a13">mx_gpu_rand_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ext_1_1OpResource.html#a3c75f8ca600930d970e3ea20cd624884">get_gpu_rand_states</a> () const</td></tr> |
| <tr class="memdesc:a3c75f8ca600930d970e3ea20cd624884"><td class="mdescLeft"> </td><td class="mdescRight">get pointer to initialized and seeded random number states located on GPU <a href="#a3c75f8ca600930d970e3ea20cd624884">More...</a><br /></td></tr> |
| <tr class="separator:a3c75f8ca600930d970e3ea20cd624884"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>provide resource APIs memory allocation mechanism to Forward/Backward functions </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a4e9eb54d2481fcb97231fec20290bd5d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4e9eb54d2481fcb97231fec20290bd5d">◆ </a></span>OpResource()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::ext::OpResource::OpResource </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespacemxnet_1_1ext.html#a6047dc7436d917e950612a84fd912760">xpu_malloc_t</a> </td> |
| <td class="paramname"><em>cpu_malloc_fp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>cpu_alloc_fp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="namespacemxnet_1_1ext.html#a6047dc7436d917e950612a84fd912760">xpu_malloc_t</a> </td> |
| <td class="paramname"><em>gpu_malloc_fp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>gpu_alloc_fp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="namespacemxnet_1_1ext.html#a4128a869e7ed8d1ed7c04037d752300e">sparse_malloc_t</a> </td> |
| <td class="paramname"><em>sparse_malloc_fp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>sparse_alloc_fp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>rng_cpu_states</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>rng_gpu_states</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aca8a01d001adef1481fa5506b76d117b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aca8a01d001adef1481fa5506b76d117b">◆ </a></span>alloc_cpu()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void* mxnet::ext::OpResource::alloc_cpu </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>size</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>allocate cpu memory controlled by MXNet </p> |
| |
| </div> |
| </div> |
| <a id="a9f2d4d97f7d2eb3c492c8f8fcfb98100"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9f2d4d97f7d2eb3c492c8f8fcfb98100">◆ </a></span>alloc_gpu()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void* mxnet::ext::OpResource::alloc_gpu </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>size</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>allocate gpu memory controlled by MXNet </p> |
| |
| </div> |
| </div> |
| <a id="a037945db6e2934e1f4acefe2c8337740"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a037945db6e2934e1f4acefe2c8337740">◆ </a></span>alloc_sparse()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mxnet::ext::OpResource::alloc_sparse </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmxnet_1_1ext_1_1MXSparse.html">MXSparse</a> * </td> |
| <td class="paramname"><em>sparse</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>index</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>indices_len</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>indptr_len</em> = <code>0</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>allocate sparse memory controlled by MXNet </p> |
| |
| </div> |
| </div> |
| <a id="acd1f86bb22908ed80946488bb99c5020"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acd1f86bb22908ed80946488bb99c5020">◆ </a></span>get_cpu_rand_states()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacemxnet_1_1ext.html#acbae2c4272b5ac64651bffbf8f000dd8">mx_cpu_rand_t</a>* mxnet::ext::OpResource::get_cpu_rand_states </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>get pointer to initialized and seeded random number states located on CPU </p> |
| |
| </div> |
| </div> |
| <a id="a712e78a6c50beca023bc20064688bd1f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a712e78a6c50beca023bc20064688bd1f">◆ </a></span>get_cuda_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="namespacemxnet_1_1ext.html#aebb5b6454e5e75b03cafa3ccebf6f752">mx_stream_t</a> mxnet::ext::OpResource::get_cuda_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>return the cuda stream object with correct type </p> |
| |
| </div> |
| </div> |
| <a id="a3c75f8ca600930d970e3ea20cd624884"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3c75f8ca600930d970e3ea20cd624884">◆ </a></span>get_gpu_rand_states()</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="namespacemxnet_1_1ext.html#a8f6f2a2bef8d1c2ca135ed4137673a13">mx_gpu_rand_t</a>* mxnet::ext::OpResource::get_gpu_rand_states </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 pointer to initialized and seeded random number states located on GPU </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/include/mxnet/<a class="el" href="lib__api_8h_source.html">lib_api.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:44 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
