| <!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: /work/mxnet/include/mxnet/engine.h File 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="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 <algorithm></code><br /> |
| <code>#include <memory></code><br /> |
| <code>#include <functional></code><br /> |
| <code>#include <vector></code><br /> |
| <code>#include "<a class="el" href="include_2mxnet_2base_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 src="engine_8h__incl.png" border="0" usemap="#_2work_2mxnet_2include_2mxnet_2engine_8h" alt=""/></div> |
| <map name="_2work_2mxnet_2include_2mxnet_2engine_8h" id="_2work_2mxnet_2include_2mxnet_2engine_8h"> |
| <area shape="rect" id="node6" href="include_2mxnet_2base_8h.html" title="./base.h" alt="" coords="2223,95,2297,121"/> |
| <area shape="rect" id="node7" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html" title="dmlc/base.h" alt="" coords="1248,468,1349,495"/> |
| <area shape="rect" id="node12" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h.html" title="dmlc/io.h" alt="" coords="436,244,519,271"/> |
| <area shape="rect" id="node23" href="type__traits_8h.html" title="type traits information header " alt="" coords="1289,393,1401,420"/> |
| <area shape="rect" id="node25" href="parameter_8h.html" title="Provide lightweight util to do parameter setup and checking. " alt="" coords="1863,244,2001,271"/> |
| <area shape="rect" id="node39" href="tensor_8h.html" title="header file of tensor data structure and functions This lib requires explicit memory allocation and d..." alt="" coords="3379,169,3520,196"/> |
| <area shape="rect" id="node47" href="op_8h.html" title="Operator information structor. " alt="" coords="2539,169,2629,196"/> |
| <area shape="rect" id="node48" href="symbolic_8h.html" title="Symbolic graph construction API. " alt="" coords="783,319,918,345"/> |
| <area shape="rect" id="node49" href="libinfo_8h.html" title="get features of the MXNet library at runtime " alt="" coords="3148,393,3223,420"/> |
| <area shape="rect" id="node50" href="include_2mxnet_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="2500,319,2567,345"/> |
| <area shape="rect" id="node11" href="build__config__default_8h.html" title="Default detection logic for fopen64 and other symbols. May be overriden by CMake. ..." alt="" coords="1030,543,1231,569"/> |
| <area shape="rect" id="node19" href="serializer_8h.html" title="serializer template class that helps serialization. This file do not need to be directly used by most..." alt="" coords="657,319,759,345"/> |
| <area shape="rect" id="node36" href="json_8h.html" title="Lightweight JSON Reader/Writer that read save into C++ data structs. This includes STL composites and..." alt="" coords="1951,319,2020,345"/> |
| <area shape="rect" id="node37" href="optional_8h.html" title="Container to hold optional data. " alt="" coords="1831,319,1926,345"/> |
| <area shape="rect" id="node38" href="strtonum_8h.html" title="A faster implementation of strtof and strtod. " alt="" coords="2071,393,2172,420"/> |
| <area shape="rect" id="node40" href="3rdparty_2mshadow_2mshadow_2base_8h.html" title="./base.h" alt="" coords="3503,468,3577,495"/> |
| <area shape="rect" id="node41" href="expression_8h.html" title="definitions of abstract expressions and expressions template " alt="" coords="3666,393,3779,420"/> |
| <area shape="rect" id="node42" href="stream__gpu-inl_8h.html" title="implementation of GPU code " alt="" coords="3399,393,3539,420"/> |
| <area shape="rect" id="node43" href="extension_8h.html" title="some extension of expressions, used to support something beyond elementwise op " alt="" coords="3519,244,3625,271"/> |
| <area shape="rect" id="node44" href="expr__engine-inl_8h.html" title="definitions of how expressions should be evaluated " alt="" coords="3557,319,3699,345"/> |
| <area shape="rect" id="node45" href="tensor__cpu-inl_8h.html" title="implementation of CPU host code " alt="" coords="3183,319,3318,345"/> |
| <area shape="rect" id="node46" href="tensor__gpu-inl_8h.html" title="implementation of GPU host code " alt="" coords="3775,244,3910,271"/> |
| </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 src="engine_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_2include_2mxnet_2engine_8hdep" alt=""/></div> |
| <map name="_2work_2mxnet_2include_2mxnet_2engine_8hdep" id="_2work_2mxnet_2include_2mxnet_2engine_8hdep"> |
| <area shape="rect" id="node2" href="include_2mxnet_2ndarray_8h.html" title="/work/mxnet/include\l/mxnet/ndarray.h" alt="" coords="565,95,720,136"/> |
| <area shape="rect" id="node7" href="include_2mxnet_2op__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/op_attr_types.h" alt="" coords="233,191,407,233"/> |
| <area shape="rect" id="node12" href="utils_8h.html" title="Basic utilility functions. " alt="" coords="117,467,305,508"/> |
| <area shape="rect" id="node16" href="resource_8h.html" title="Global resource allocation handling. " alt="" coords="357,95,512,136"/> |
| <area shape="rect" id="node3" href="packed__func_8h.html" title="Type-erased function used across MXNET API. " alt="" coords="1011,184,1186,240"/> |
| <area shape="rect" id="node6" href="include_2mxnet_2executor_8h.html" title="/work/mxnet/include\l/mxnet/executor.h" alt="" coords="661,377,816,419"/> |
| <area shape="rect" id="node11" href="imperative_8h.html" title="/work/mxnet/include\l/mxnet/imperative.h" alt="" coords="133,377,288,419"/> |
| <area shape="rect" id="node14" href="include_2mxnet_2io_8h.html" title="/work/mxnet/include\l/mxnet/io.h" alt="" coords="549,191,704,233"/> |
| <area shape="rect" id="node15" href="include_2mxnet_2kvstore_8h.html" title="/work/mxnet/include\l/mxnet/kvstore.h" alt="" coords="728,191,883,233"/> |
| <area shape="rect" id="node4" href="include_2mxnet_2runtime_2registry_8h.html" title="/work/mxnet/include\l/mxnet/runtime/registry.h" alt="" coords="1008,288,1195,329"/> |
| <area shape="rect" id="node5" href="api__registry_8h.html" title="This file contains utilities related to the MXNet's global function registry. " alt="" coords="1022,377,1181,419"/> |
| <area shape="rect" id="node8" href="include_2mxnet_2operator_8h.html" title="/work/mxnet/include\l/mxnet/operator.h" alt="" coords="363,288,517,329"/> |
| <area shape="rect" id="node10" href="include_2mxnet_2graph__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/graph_attr_types.h" alt="" coords="43,288,237,329"/> |
| <area shape="rect" id="node9" href="operator__util_8h.html" title="Utility functions and registries to help quickly build new operators. [Deprecated] Use the register f..." alt="" coords="363,377,530,419"/> |
| <area shape="rect" id="node13" href="exec__utils_8h.html" title="Common utility functions for executors. " alt="" coords="117,556,305,597"/> |
| </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 class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1engine_1_1Var.html">mxnet::engine::Var</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">base class of engine variables. <a href="structmxnet_1_1engine_1_1Var.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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>, |
| <a class="el" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba4879e1f172ddec6223d17ea90e691ddd">mxnet::FnProperty::kGPUPrioritized</a>, |
| <a class="el" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3bac76ad5584b42e2ba06f1b5e9ebac8b2a">mxnet::FnProperty::kNoSkip</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 name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Engine that schedules all the operations according to dependency. </p> |
| </div></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:43 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> |
