blob: 330b22c18952814ab1b2bd58a23262f25c178f65 [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 content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/>
<meta content="IE=9" http-equiv="X-UA-Compatible"/>
<meta content="Doxygen 1.8.11" name="generator"/>
<title>mxnet: include/mxnet/engine.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script src="jquery.js" type="text/javascript"></script>
<script src="dynsections.js" type="text/javascript"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script src="search/searchdata.js" type="text/javascript"></script>
<script src="search/search.js" type="text/javascript"></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 cellpadding="0" cellspacing="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 class="tabs" id="navrow1">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div class="MSearchBoxInactive" id="MSearchBox">
<span class="left">
<img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/>
<input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/>
</span><span class="right">
<a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a>
</span>
</div>
</li>
</ul>
</div>
<div class="tabs2" id="navrow2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)">
</iframe>
</div>
<div class="navpath" id="nav-path">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#namespaces">Namespaces</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">engine.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Engine that schedules all the operations according to dependency.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;dmlc/base.h&gt;</code><br/>
<code>#include &lt;algorithm&gt;</code><br/>
<code>#include &lt;memory&gt;</code><br/>
<code>#include &lt;functional&gt;</code><br/>
<code>#include &lt;vector&gt;</code><br/>
<code>#include "<a class="el" href="base_8h_source.html">./base.h</a>"</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for engine.h:</div>
<div class="dyncontent">
<div class="center"><img alt="" border="0" src="engine_8h__incl.png" usemap="#include_2mxnet_2engine_8h"/></div>
<map id="include_2mxnet_2engine_8h" name="include_2mxnet_2engine_8h">
<area alt="" coords="540,80,609,107" href="base_8h.html" id="node7" shape="rect" title="configuation of mxnet as well as basic data structure. "/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img alt="" border="0" src="engine_8h__dep__incl.png" usemap="#include_2mxnet_2engine_8hdep"/></div>
<map id="include_2mxnet_2engine_8hdep" name="include_2mxnet_2engine_8hdep">
<area alt="" coords="399,80,561,107" href="ndarray_8h.html" id="node2" shape="rect" title="NDArray interface that handles array arithematics. "/>
<area alt="" coords="85,155,232,196" href="op__attr__types_8h.html" id="node4" shape="rect" title="Additional operator attributes beside the ones provided by NNVM. "/>
<area alt="" coords="751,341,884,367" href="utils_8h.html" id="node9" shape="rect" title="Basic utilility functions. "/>
<area alt="" coords="75,80,243,107" href="resource_8h.html" id="node14" shape="rect" title="Global resource allocation handling. "/>
<area alt="" coords="185,341,353,367" href="executor_8h.html" id="node3" shape="rect" title="Symbolic executor interface of mxnet. "/>
<area alt="" coords="417,341,596,367" href="imperative_8h.html" id="node8" shape="rect" title="include/mxnet/imperative.h"/>
<area alt="" coords="701,162,829,189" href="io_8h.html" id="node11" shape="rect" title="mxnet io data structure and data iterator "/>
<area alt="" coords="307,162,469,189" href="kvstore_8h.html" id="node12" shape="rect" title="key-value store interface for mxnet "/>
<area alt="" coords="544,162,677,189" href="rtc_8h.html" id="node13" shape="rect" title="include/mxnet/rtc.h"/>
<area alt="" coords="5,251,171,278" href="operator_8h.html" id="node5" shape="rect" title="Operator interface of mxnet. "/>
<area alt="" coords="544,244,683,285" href="graph__attr__types_8h.html" id="node7" shape="rect" title="Data structures that can appear in graph attributes. "/>
<area alt="" coords="7,333,161,375" href="operator__util_8h.html" id="node6" shape="rect" title="Utility functions and registries to help quickly build new operators. [Deprecated] Use the register f..."/>
<area alt="" coords="733,423,901,449" href="exec__utils_8h.html" id="node10" shape="rect" title="Common utility functions for executors. "/>
</map>
</div>
</div>
<p><a href="engine_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td align="right" class="memItemLeft" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1engine_1_1CallbackOnComplete.html">mxnet::engine::CallbackOnComplete</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">OnComplete Callback to the engine, called by AsyncFn when action completes. <a href="classmxnet_1_1engine_1_1CallbackOnComplete.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td align="right" class="memItemLeft" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Engine.html">mxnet::Engine</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Dependency engine that schedules operations. <a href="classmxnet_1_1Engine.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacemxnet"><td align="right" class="memItemLeft" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html">mxnet</a></td></tr>
<tr class="memdesc:namespacemxnet"><td class="mdescLeft"> </td><td class="mdescRight">namespace of mxnet <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:namespacemxnet_1_1engine"><td align="right" class="memItemLeft" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1engine.html">mxnet::engine</a></td></tr>
<tr class="memdesc:namespacemxnet_1_1engine"><td class="mdescLeft"> </td><td class="mdescRight">namespace of engine internal types. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a9d36c4f33eae8531586dc2edf83ae7cf"><td align="right" class="memItemLeft" valign="top">typedef Var * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf">mxnet::engine::VarHandle</a></td></tr>
<tr class="memdesc:a9d36c4f33eae8531586dc2edf83ae7cf"><td class="mdescLeft"> </td><td class="mdescRight">Variable pointer type, usually hold by user used to specify dependencies. <a href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf">More...</a><br/></td></tr>
<tr class="separator:a9d36c4f33eae8531586dc2edf83ae7cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d9b14b658e3f3c4e03ca49cd38ace94"><td align="right" class="memItemLeft" valign="top">typedef Opr * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1engine.html#a2d9b14b658e3f3c4e03ca49cd38ace94">mxnet::engine::OprHandle</a></td></tr>
<tr class="memdesc:a2d9b14b658e3f3c4e03ca49cd38ace94"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmxnet_1_1Operator.html" title="Operator interface. Operator defines basic operation unit of optimized computation graph in mxnet...">Operator</a> pointer type, usually hold by user. <a href="namespacemxnet_1_1engine.html#a2d9b14b658e3f3c4e03ca49cd38ace94">More...</a><br/></td></tr>
<tr class="separator:a2d9b14b658e3f3c4e03ca49cd38ace94"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a998b74220fab2b012cf8a179650e1b3b"><td align="right" class="memItemLeft" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3b">mxnet::FnProperty</a> { <br/>
  <a class="el" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba07fa7a19aa722c635a15e94cb7f50416">mxnet::FnProperty::kNormal</a>,
<a class="el" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba739f2f416f05f4728c217f09e93958d1">mxnet::FnProperty::kCopyFromGPU</a>,
<a class="el" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba6cd75f41e0ec8d61b0a2f0e20ef6d1e8">mxnet::FnProperty::kCopyToGPU</a>,
<a class="el" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3bac41ceb98eeb9b2e208e3e242a7357142">mxnet::FnProperty::kCPUPrioritized</a>,
<br/>
  <a class="el" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba9f2b960005d2a3a5f35ac32809d84db7">mxnet::FnProperty::kAsync</a>,
<a class="el" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3bac41fda8552e9d327ad3b06b1bafa663a">mxnet::FnProperty::kDeleteVar</a>
<br/>
}<tr class="memdesc:a998b74220fab2b012cf8a179650e1b3b"><td class="mdescLeft"> </td><td class="mdescRight">Function property, used to hint what action is pushed to engine. <a href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3b">More...</a><br/></td></tr>
</td></tr>
<tr class="separator:a998b74220fab2b012cf8a179650e1b3b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Engine that schedules all the operations according to dependency. </p>
<p>Copyright (c) 2015 by Contributors </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 28 2018 22:11:03 for mxnet by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="doxygen.png"/>
</a> 1.8.11
</small></address>
</body>
</html>