blob: cadb68abf4679636160db5086709a1ef53bd1ee8 [file] [log] [blame]
<!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::ResourceManager 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="classmxnet_1_1ResourceManager.html">ResourceManager</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classmxnet_1_1ResourceManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::ResourceManager Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Global resource manager.
<a href="classmxnet_1_1ResourceManager.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="resource_8h_source.html">resource.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::ResourceManager:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1ResourceManager__coll__graph.png" border="0" usemap="#mxnet_1_1ResourceManager_coll__map" alt="Collaboration graph"/></div>
<map name="mxnet_1_1ResourceManager_coll__map" id="mxnet_1_1ResourceManager_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:a276e4e3ae229a118e50a03955f3f1a08"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structmxnet_1_1Resource.html">Resource</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ResourceManager.html#a276e4e3ae229a118e50a03955f3f1a08">Request</a> (<a class="el" href="structmxnet_1_1Context.html">Context</a> ctx, const <a class="el" href="structmxnet_1_1ResourceRequest.html">ResourceRequest</a> &amp;req)=0</td></tr>
<tr class="memdesc:a276e4e3ae229a118e50a03955f3f1a08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get resource of requested type. <a href="#a276e4e3ae229a118e50a03955f3f1a08">More...</a><br /></td></tr>
<tr class="separator:a276e4e3ae229a118e50a03955f3f1a08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7aa335bc9231a8eb7cd04de22e033603"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ResourceManager.html#a7aa335bc9231a8eb7cd04de22e033603">SeedRandom</a> (uint32_t seed)=0</td></tr>
<tr class="memdesc:a7aa335bc9231a8eb7cd04de22e033603"><td class="mdescLeft">&#160;</td><td class="mdescRight">Seed all the allocated random number generators. <a href="#a7aa335bc9231a8eb7cd04de22e033603">More...</a><br /></td></tr>
<tr class="separator:a7aa335bc9231a8eb7cd04de22e033603"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a143d445deda8f08aab3316b14004a588"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ResourceManager.html#a143d445deda8f08aab3316b14004a588">SeedRandom</a> (<a class="el" href="structmxnet_1_1Context.html">Context</a> ctx, uint32_t seed)=0</td></tr>
<tr class="memdesc:a143d445deda8f08aab3316b14004a588"><td class="mdescLeft">&#160;</td><td class="mdescRight">Seed the random number generators of the given context. <a href="#a143d445deda8f08aab3316b14004a588">More...</a><br /></td></tr>
<tr class="separator:a143d445deda8f08aab3316b14004a588"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b53c0843ddbaf7ccb9e06f448b20cac"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ResourceManager.html#a2b53c0843ddbaf7ccb9e06f448b20cac">~ResourceManager</a> () <a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a80bde16113dc79e7adb7953e006d6b60">DMLC_THROW_EXCEPTION</a></td></tr>
<tr class="memdesc:a2b53c0843ddbaf7ccb9e06f448b20cac"><td class="mdescLeft">&#160;</td><td class="mdescRight">virtual destructor <a href="#a2b53c0843ddbaf7ccb9e06f448b20cac">More...</a><br /></td></tr>
<tr class="separator:a2b53c0843ddbaf7ccb9e06f448b20cac"><td class="memSeparator" colspan="2">&#160;</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:a5712bb055045ba9fb45dd3cdb812abb8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmxnet_1_1ResourceManager.html">ResourceManager</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1ResourceManager.html#a5712bb055045ba9fb45dd3cdb812abb8">Get</a> ()</td></tr>
<tr class="separator:a5712bb055045ba9fb45dd3cdb812abb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Global resource manager. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2b53c0843ddbaf7ccb9e06f448b20cac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b53c0843ddbaf7ccb9e06f448b20cac">&#9670;&nbsp;</a></span>~ResourceManager()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual mxnet::ResourceManager::~ResourceManager </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>virtual destructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5712bb055045ba9fb45dd3cdb812abb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5712bb055045ba9fb45dd3cdb812abb8">&#9670;&nbsp;</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 <a class="el" href="classmxnet_1_1ResourceManager.html">ResourceManager</a>* mxnet::ResourceManager::Get </td>
<td>(</td>
<td class="paramname"></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">
<dl class="section return"><dt>Returns</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> manager singleton. </dd></dl>
</div>
</div>
<a id="a276e4e3ae229a118e50a03955f3f1a08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a276e4e3ae229a118e50a03955f3f1a08">&#9670;&nbsp;</a></span>Request()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structmxnet_1_1Resource.html">Resource</a> mxnet::ResourceManager::Request </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmxnet_1_1Context.html">Context</a>&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1ResourceRequest.html">ResourceRequest</a> &amp;&#160;</td>
<td class="paramname"><em>req</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get resource of requested type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>the context of the request. </td></tr>
<tr><td class="paramname">req</td><td>the resource request. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the requested resource. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The returned resource's ownership is still hold by the manager singleton. </dd></dl>
</div>
</div>
<a id="a7aa335bc9231a8eb7cd04de22e033603"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7aa335bc9231a8eb7cd04de22e033603">&#9670;&nbsp;</a></span>SeedRandom() <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">virtual void mxnet::ResourceManager::SeedRandom </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>seed</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Seed all the allocated random number generators. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seed</td><td>the seed to the random number generators on all devices. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a143d445deda8f08aab3316b14004a588"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a143d445deda8f08aab3316b14004a588">&#9670;&nbsp;</a></span>SeedRandom() <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">virtual void mxnet::ResourceManager::SeedRandom </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmxnet_1_1Context.html">Context</a>&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>seed</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Seed the random number generators of the given context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seed</td><td>the seed to the random number generators. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/include/mxnet/<a class="el" href="resource_8h_source.html">resource.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>