blob: e5830abcac90474ddf67b7d399284af5df7a2cec [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: mxnet::Context 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.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="structmxnet_1_1Context.html">Context</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="structmxnet_1_1Context-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::Context Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment.">Context</a> information about the execution environment.
<a href="structmxnet_1_1Context.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="include_2mxnet_2base_8h_source.html">base.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::Context:</div>
<div class="dyncontent">
<div class="center"><img src="structmxnet_1_1Context__coll__graph.png" border="0" usemap="#mxnet_1_1Context_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</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:a611c227b5e04a2777c3e4507bb76f60e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a> { <a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60ea1aced5778bb0d64d4ce6bd4c0a86d140">kCPU</a> = cpu::kDevMask,
<a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60eab21bed4d5cee411db15283d7529f28cf">kGPU</a> = gpu::kDevMask,
<a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60eaa2e12b86e0f957dc14d45863eaa47f34">kCPUPinned</a> = 3,
<a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60ea80c6f8f13908c5805cf12784fca77e78">kCPUShared</a> = 5
}</td></tr>
<tr class="memdesc:a611c227b5e04a2777c3e4507bb76f60e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of device. <a href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">More...</a><br /></td></tr>
<tr class="separator:a611c227b5e04a2777c3e4507bb76f60e"><td class="memSeparator" colspan="2">&#160;</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:a290642a21363bef82bcb32cf7f98b884"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a290642a21363bef82bcb32cf7f98b884">Context</a> ()</td></tr>
<tr class="memdesc:a290642a21363bef82bcb32cf7f98b884"><td class="mdescLeft">&#160;</td><td class="mdescRight">default constructor <a href="structmxnet_1_1Context.html#a290642a21363bef82bcb32cf7f98b884">More...</a><br /></td></tr>
<tr class="separator:a290642a21363bef82bcb32cf7f98b884"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41f5317543ececa2d0feeea1093e219c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a41f5317543ececa2d0feeea1093e219c">dev_mask</a> () const</td></tr>
<tr class="memdesc:a41f5317543ececa2d0feeea1093e219c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get corresponding device mask. <a href="structmxnet_1_1Context.html#a41f5317543ececa2d0feeea1093e219c">More...</a><br /></td></tr>
<tr class="separator:a41f5317543ececa2d0feeea1093e219c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2514ea43328d921a74423b7670a3fad"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#af2514ea43328d921a74423b7670a3fad">real_dev_id</a> () const</td></tr>
<tr class="memdesc:af2514ea43328d921a74423b7670a3fad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns dev_id for kGPU and kCPUPinned, 0 otherwise. <a href="structmxnet_1_1Context.html#af2514ea43328d921a74423b7670a3fad">More...</a><br /></td></tr>
<tr class="separator:af2514ea43328d921a74423b7670a3fad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd07473e20810635cb3fffc216d76494"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#afd07473e20810635cb3fffc216d76494">operator&lt;</a> (const <a class="el" href="structmxnet_1_1Context.html">Context</a> &amp;b) const</td></tr>
<tr class="memdesc:afd07473e20810635cb3fffc216d76494"><td class="mdescLeft">&#160;</td><td class="mdescRight">Comparator, used to enable <a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment.">Context</a> as std::map key. <a href="structmxnet_1_1Context.html#afd07473e20810635cb3fffc216d76494">More...</a><br /></td></tr>
<tr class="separator:afd07473e20810635cb3fffc216d76494"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b8d414a429c12ab55cfa9ed13539393"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a8b8d414a429c12ab55cfa9ed13539393">operator==</a> (const <a class="el" href="structmxnet_1_1Context.html">Context</a> &amp;b) const</td></tr>
<tr class="memdesc:a8b8d414a429c12ab55cfa9ed13539393"><td class="mdescLeft">&#160;</td><td class="mdescRight">check if current context equals another one <a href="structmxnet_1_1Context.html#a8b8d414a429c12ab55cfa9ed13539393">More...</a><br /></td></tr>
<tr class="separator:a8b8d414a429c12ab55cfa9ed13539393"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e84dc72147472e72b50e8545780fd1e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a7e84dc72147472e72b50e8545780fd1e">operator!=</a> (const <a class="el" href="structmxnet_1_1Context.html">Context</a> &amp;b) const</td></tr>
<tr class="memdesc:a7e84dc72147472e72b50e8545780fd1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">check if current context not equals another one <a href="structmxnet_1_1Context.html#a7e84dc72147472e72b50e8545780fd1e">More...</a><br /></td></tr>
<tr class="separator:a7e84dc72147472e72b50e8545780fd1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ea910ddb7e15d51320806b1666bf6c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a9ea910ddb7e15d51320806b1666bf6c5">Save</a> (<a class="el" href="classdmlc_1_1Stream.html">dmlc::Stream</a> *strm) const</td></tr>
<tr class="memdesc:a9ea910ddb7e15d51320806b1666bf6c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">save the content into binary stream <a href="structmxnet_1_1Context.html#a9ea910ddb7e15d51320806b1666bf6c5">More...</a><br /></td></tr>
<tr class="separator:a9ea910ddb7e15d51320806b1666bf6c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a882305327a53b9b9a82f5802b4b013e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a882305327a53b9b9a82f5802b4b013e3">Load</a> (<a class="el" href="classdmlc_1_1Stream.html">dmlc::Stream</a> *strm)</td></tr>
<tr class="memdesc:a882305327a53b9b9a82f5802b4b013e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">load the content from binary stream <a href="structmxnet_1_1Context.html#a882305327a53b9b9a82f5802b4b013e3">More...</a><br /></td></tr>
<tr class="separator:a882305327a53b9b9a82f5802b4b013e3"><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:a7cea13406ae21ae557d3455f54670a4a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structmxnet_1_1Context.html">Context</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a7cea13406ae21ae557d3455f54670a4a">Create</a> (<a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a> <a class="el" href="structmxnet_1_1Context.html#a66040df23c2a5663f29bc50aa0bbace3">dev_type</a>, int32_t <a class="el" href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">dev_id</a>=-1)</td></tr>
<tr class="memdesc:a7cea13406ae21ae557d3455f54670a4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new context. <a href="structmxnet_1_1Context.html#a7cea13406ae21ae557d3455f54670a4a">More...</a><br /></td></tr>
<tr class="separator:a7cea13406ae21ae557d3455f54670a4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bb231d70623fde216de51589347e513"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structmxnet_1_1Context.html">Context</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a4bb231d70623fde216de51589347e513">CPU</a> (int32_t <a class="el" href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">dev_id</a>=0)</td></tr>
<tr class="separator:a4bb231d70623fde216de51589347e513"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39d1a2b59bce135da127475995a58671"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structmxnet_1_1Context.html">Context</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a39d1a2b59bce135da127475995a58671">GPU</a> (int32_t <a class="el" href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">dev_id</a>=-1)</td></tr>
<tr class="separator:a39d1a2b59bce135da127475995a58671"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adde995df8e2b9871151921a932788cd2"><td class="memItemLeft" align="right" valign="top">static int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#adde995df8e2b9871151921a932788cd2">GetGPUCount</a> ()</td></tr>
<tr class="separator:adde995df8e2b9871151921a932788cd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab50bb4c3439d200f5e82702cec587aef"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#ab50bb4c3439d200f5e82702cec587aef">GPUDriverPresent</a> ()</td></tr>
<tr class="separator:ab50bb4c3439d200f5e82702cec587aef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8368603622d6af4609fe78f572387b59"><td class="memItemLeft" align="right" valign="top">static int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a8368603622d6af4609fe78f572387b59">GetGPUStreamsPerWorker</a> ()</td></tr>
<tr class="separator:a8368603622d6af4609fe78f572387b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e1512621b22a14035f740703d3eb006"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a7e1512621b22a14035f740703d3eb006">GetGPUMemoryInformation</a> (int dev, uint64_t *free, uint64_t *total)</td></tr>
<tr class="memdesc:a7e1512621b22a14035f740703d3eb006"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the free and total available memory on a GPU <a href="structmxnet_1_1Context.html#a7e1512621b22a14035f740703d3eb006">More...</a><br /></td></tr>
<tr class="separator:a7e1512621b22a14035f740703d3eb006"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a420d4e662a5129b202507f42c991391c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structmxnet_1_1Context.html">Context</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a420d4e662a5129b202507f42c991391c">CPUPinned</a> (int32_t <a class="el" href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">dev_id</a>=-1)</td></tr>
<tr class="separator:a420d4e662a5129b202507f42c991391c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e090b1fcc96b682512bcc22fc521f80"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structmxnet_1_1Context.html">Context</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a8e090b1fcc96b682512bcc22fc521f80">CPUShared</a> (int32_t <a class="el" href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">dev_id</a>=0)</td></tr>
<tr class="separator:a8e090b1fcc96b682512bcc22fc521f80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b7e2c87496a90b6b0ed06eab61956c4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structmxnet_1_1Context.html">Context</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a4b7e2c87496a90b6b0ed06eab61956c4">FromString</a> (const std::string &amp;str)</td></tr>
<tr class="separator:a4b7e2c87496a90b6b0ed06eab61956c4"><td class="memSeparator" colspan="2">&#160;</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:a66040df23c2a5663f29bc50aa0bbace3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a66040df23c2a5663f29bc50aa0bbace3">dev_type</a></td></tr>
<tr class="memdesc:a66040df23c2a5663f29bc50aa0bbace3"><td class="mdescLeft">&#160;</td><td class="mdescRight">the device type we run the op on <a href="structmxnet_1_1Context.html#a66040df23c2a5663f29bc50aa0bbace3">More...</a><br /></td></tr>
<tr class="separator:a66040df23c2a5663f29bc50aa0bbace3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8486dcc599dffe447e2f098b170d3db9"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">dev_id</a></td></tr>
<tr class="memdesc:a8486dcc599dffe447e2f098b170d3db9"><td class="mdescLeft">&#160;</td><td class="mdescRight">device id we are going to run it on <a href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">More...</a><br /></td></tr>
<tr class="separator:a8486dcc599dffe447e2f098b170d3db9"><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-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a7433936d1daf38f7dced0de49fbe6a4b"><td class="memItemLeft" align="right" valign="top">static const int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a7433936d1daf38f7dced0de49fbe6a4b">kMaxDevType</a> = 6</td></tr>
<tr class="memdesc:a7433936d1daf38f7dced0de49fbe6a4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">the maximal device type <a href="structmxnet_1_1Context.html#a7433936d1daf38f7dced0de49fbe6a4b">More...</a><br /></td></tr>
<tr class="separator:a7433936d1daf38f7dced0de49fbe6a4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a958219ae412395685ef1d82af0dbbe67"><td class="memItemLeft" align="right" valign="top">static const int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a958219ae412395685ef1d82af0dbbe67">kMaxDevID</a> = 16</td></tr>
<tr class="memdesc:a958219ae412395685ef1d82af0dbbe67"><td class="mdescLeft">&#160;</td><td class="mdescRight">the maximal device index <a href="structmxnet_1_1Context.html#a958219ae412395685ef1d82af0dbbe67">More...</a><br /></td></tr>
<tr class="separator:a958219ae412395685ef1d82af0dbbe67"><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><a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment.">Context</a> information about the execution environment. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a611c227b5e04a2777c3e4507bb76f60e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a611c227b5e04a2777c3e4507bb76f60e">&#9670;&nbsp;</a></span>DeviceType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">mxnet::Context::DeviceType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of device. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a611c227b5e04a2777c3e4507bb76f60ea1aced5778bb0d64d4ce6bd4c0a86d140"></a>kCPU&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a611c227b5e04a2777c3e4507bb76f60eab21bed4d5cee411db15283d7529f28cf"></a>kGPU&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a611c227b5e04a2777c3e4507bb76f60eaa2e12b86e0f957dc14d45863eaa47f34"></a>kCPUPinned&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a611c227b5e04a2777c3e4507bb76f60ea80c6f8f13908c5805cf12784fca77e78"></a>kCPUShared&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a290642a21363bef82bcb32cf7f98b884"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a290642a21363bef82bcb32cf7f98b884">&#9670;&nbsp;</a></span>Context()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::Context::Context </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>default constructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4bb231d70623fde216de51589347e513"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bb231d70623fde216de51589347e513">&#9670;&nbsp;</a></span>CPU()</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="structmxnet_1_1Context.html">Context</a> mxnet::Context::CPU </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>dev_id</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>CPU <a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment.">Context</a> </dd></dl>
</div>
</div>
<a id="a420d4e662a5129b202507f42c991391c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a420d4e662a5129b202507f42c991391c">&#9670;&nbsp;</a></span>CPUPinned()</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="structmxnet_1_1Context.html">Context</a> mxnet::Context::CPUPinned </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>dev_id</em> = <code>-1</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a pinned CPU context. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev_id</td><td>the device id for corresponding GPU. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pinned CPU context. -1 for current GPU. </dd></dl>
</div>
</div>
<a id="a8e090b1fcc96b682512bcc22fc521f80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e090b1fcc96b682512bcc22fc521f80">&#9670;&nbsp;</a></span>CPUShared()</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="structmxnet_1_1Context.html">Context</a> mxnet::Context::CPUShared </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>dev_id</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a CPU shared memory context. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev_id</td><td>dummy device id. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CPU shared memory context. </dd></dl>
</div>
</div>
<a id="a7cea13406ae21ae557d3455f54670a4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cea13406ae21ae557d3455f54670a4a">&#9670;&nbsp;</a></span>Create()</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="structmxnet_1_1Context.html">Context</a> mxnet::Context::Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a>&#160;</td>
<td class="paramname"><em>dev_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>dev_id</em> = <code>-1</code>&#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">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev_type</td><td>device type. </td></tr>
<tr><td class="paramname">dev_id</td><td>device id. -1 for current device. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a41f5317543ececa2d0feeea1093e219c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41f5317543ececa2d0feeea1093e219c">&#9670;&nbsp;</a></span>dev_mask()</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="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a> mxnet::Context::dev_mask </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 corresponding device mask. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structmshadow_1_1cpu.html#a57f74b500825e21c0c246ad5b4e5016b" title="device flag number, identifies this device">cpu::kDevMask</a> or <a class="el" href="structmshadow_1_1gpu.html#a15467f39ddeed96fa259efda7c988f05" title="device flag number, identifies this device">gpu::kDevMask</a> </dd></dl>
</div>
</div>
<a id="a4b7e2c87496a90b6b0ed06eab61956c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b7e2c87496a90b6b0ed06eab61956c4">&#9670;&nbsp;</a></span>FromString()</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="structmxnet_1_1Context.html">Context</a> mxnet::Context::FromString </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a context from string of the format [cpu|gpu|cpu_pinned](n) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>the string pattern </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment.">Context</a> </dd></dl>
</div>
</div>
<a id="adde995df8e2b9871151921a932788cd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adde995df8e2b9871151921a932788cd2">&#9670;&nbsp;</a></span>GetGPUCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int32_t mxnet::Context::GetGPUCount </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of GPUs available. </p><dl class="section return"><dt>Returns</dt><dd>The number of GPUs that are available. </dd></dl>
</div>
</div>
<a id="a7e1512621b22a14035f740703d3eb006"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e1512621b22a14035f740703d3eb006">&#9670;&nbsp;</a></span>GetGPUMemoryInformation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void mxnet::Context::GetGPUMemoryInformation </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t *&#160;</td>
<td class="paramname"><em>free</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t *&#160;</td>
<td class="paramname"><em>total</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">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>get the free and total available memory on a GPU </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>the GPU number to query </td></tr>
<tr><td class="paramname">free_mem</td><td>pointer to the uint64_t holding free GPU memory </td></tr>
<tr><td class="paramname">total_mem</td><td>pointer to the uint64_t holding total GPU memory </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
</div>
</div>
<a id="a8368603622d6af4609fe78f572387b59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8368603622d6af4609fe78f572387b59">&#9670;&nbsp;</a></span>GetGPUStreamsPerWorker()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int32_t mxnet::Context::GetGPUStreamsPerWorker </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of streams that a GPU Worker has available to operations. </p><dl class="section return"><dt>Returns</dt><dd>The number of streams that are available. </dd></dl>
</div>
</div>
<a id="a39d1a2b59bce135da127475995a58671"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39d1a2b59bce135da127475995a58671">&#9670;&nbsp;</a></span>GPU()</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="structmxnet_1_1Context.html">Context</a> mxnet::Context::GPU </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>dev_id</em> = <code>-1</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a GPU context. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev_id</td><td>the device id. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>GPU <a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment.">Context</a>. -1 for current GPU. </dd></dl>
</div>
</div>
<a id="ab50bb4c3439d200f5e82702cec587aef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab50bb4c3439d200f5e82702cec587aef">&#9670;&nbsp;</a></span>GPUDriverPresent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool mxnet::Context::GPUDriverPresent </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Is the cuda driver installed and visible to the system. </p><dl class="section return"><dt>Returns</dt><dd>Whether the driver is present. </dd></dl>
</div>
</div>
<a id="a882305327a53b9b9a82f5802b4b013e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a882305327a53b9b9a82f5802b4b013e3">&#9670;&nbsp;</a></span>Load()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::Context::Load </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdmlc_1_1Stream.html">dmlc::Stream</a> *&#160;</td>
<td class="paramname"><em>strm</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>load the content from binary stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">strm</td><td>the output stream </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether the load is successful </dd></dl>
</div>
</div>
<a id="a7e84dc72147472e72b50e8545780fd1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e84dc72147472e72b50e8545780fd1e">&#9670;&nbsp;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::Context::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1Context.html">Context</a> &amp;&#160;</td>
<td class="paramname"><em>b</em></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>check if current context not equals another one </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>another context to compare </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether they are not the same </dd></dl>
</div>
</div>
<a id="afd07473e20810635cb3fffc216d76494"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd07473e20810635cb3fffc216d76494">&#9670;&nbsp;</a></span>operator&lt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::Context::operator&lt; </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1Context.html">Context</a> &amp;&#160;</td>
<td class="paramname"><em>b</em></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>Comparator, used to enable <a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment.">Context</a> as std::map key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>another context to compare </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>compared result </dd></dl>
</div>
</div>
<a id="a8b8d414a429c12ab55cfa9ed13539393"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b8d414a429c12ab55cfa9ed13539393">&#9670;&nbsp;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::Context::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1Context.html">Context</a> &amp;&#160;</td>
<td class="paramname"><em>b</em></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>check if current context equals another one </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>another context to compare </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether dev mask and id are same </dd></dl>
</div>
</div>
<a id="af2514ea43328d921a74423b7670a3fad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2514ea43328d921a74423b7670a3fad">&#9670;&nbsp;</a></span>real_dev_id()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int mxnet::Context::real_dev_id </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>Returns dev_id for kGPU and kCPUPinned, 0 otherwise. </p>
</div>
</div>
<a id="a9ea910ddb7e15d51320806b1666bf6c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ea910ddb7e15d51320806b1666bf6c5">&#9670;&nbsp;</a></span>Save()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mxnet::Context::Save </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdmlc_1_1Stream.html">dmlc::Stream</a> *&#160;</td>
<td class="paramname"><em>strm</em></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>save the content into binary stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">strm</td><td>the output stream </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8486dcc599dffe447e2f098b170d3db9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8486dcc599dffe447e2f098b170d3db9">&#9670;&nbsp;</a></span>dev_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t mxnet::Context::dev_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>device id we are going to run it on </p>
</div>
</div>
<a id="a66040df23c2a5663f29bc50aa0bbace3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66040df23c2a5663f29bc50aa0bbace3">&#9670;&nbsp;</a></span>dev_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a> mxnet::Context::dev_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>the device type we run the op on </p>
</div>
</div>
<a id="a958219ae412395685ef1d82af0dbbe67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a958219ae412395685ef1d82af0dbbe67">&#9670;&nbsp;</a></span>kMaxDevID</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int32_t mxnet::Context::kMaxDevID = 16</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>the maximal device index </p>
</div>
</div>
<a id="a7433936d1daf38f7dced0de49fbe6a4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7433936d1daf38f7dced0de49fbe6a4b">&#9670;&nbsp;</a></span>kMaxDevType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int32_t mxnet::Context::kMaxDevType = 6</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>the maximal device type </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_2base_8h_source.html">base.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:41 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>