blob: 77a06bba2e94ecda1df5b0f13419b348552ef6d8 [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: /work/mxnet/src/common/exec_utils.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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_fdedb0aba14d44ce9d99bc100e026e6a.html">common</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">exec_utils.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Common utility functions for executors.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="graph_8h_source.html">nnvm/graph.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="pass__functions_8h_source.html">nnvm/pass_functions.h</a>&gt;</code><br />
<code>#include &lt;map&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &quot;<a class="el" href="utils_8h_source.html">../common/utils.h</a>&quot;</code><br />
<code>#include &quot;../executor/exec_pass.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for exec_utils.h:</div>
<div class="dyncontent">
<div class="center"><img src="exec__utils_8h__incl.png" border="0" usemap="#_2work_2mxnet_2src_2common_2exec__utils_8h" alt=""/></div>
<map name="_2work_2mxnet_2src_2common_2exec__utils_8h" id="_2work_2mxnet_2src_2common_2exec__utils_8h">
<area shape="rect" id="node2" href="graph_8h.html" title="Configuation of nnvm as well as basic data structure. " alt="" coords="1049,333,1161,360"/>
<area shape="rect" id="node17" href="pass__functions_8h.html" title="Pass functions that simply redirect the calls to ApplyPass. " alt="" coords="822,184,994,211"/>
<area shape="rect" id="node22" href="utils_8h.html" title="Basic utilility functions. " alt="" coords="1745,102,1879,129"/>
<area shape="rect" id="node10" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2base_8h.html" title="Configuration of nnvm as well as basic data structure. " alt="" coords="1431,557,1497,584"/>
<area shape="rect" id="node14" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2node_8h.html" title="Graph node data structure. " alt="" coords="933,483,1000,509"/>
<area shape="rect" id="node15" href="symbolic_8h.html" title="Symbolic graph construction API. " alt="" coords="835,408,928,435"/>
<area shape="rect" id="node11" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html" title="dmlc/base.h" alt="" coords="1420,632,1521,659"/>
<area shape="rect" id="node12" href="common_8h.html" title="defines some common utility function. " alt="" coords="1055,632,1182,659"/>
<area shape="rect" id="node18" href="pass_8h.html" title="Pass that can be applied to a graph. " alt="" coords="1579,259,1643,285"/>
<area shape="rect" id="node20" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2graph__attr__types_8h.html" title="Data structures that can appear in graph attributes. " alt="" coords="1125,483,1269,509"/>
<area shape="rect" id="node23" href="omp_8h.html" title="header to handle OpenMP compatibility issues " alt="" coords="1133,184,1232,211"/>
<area shape="rect" id="node24" href="engine_8h.html" title="Engine that schedules all the operations according to dependency. " alt="" coords="2281,483,2405,509"/>
<area shape="rect" id="node25" href="include_2mxnet_2ndarray_8h.html" title="mxnet/ndarray.h" alt="" coords="1824,408,1952,435"/>
<area shape="rect" id="node26" href="imperative_8h.html" title="mxnet/imperative.h" alt="" coords="1307,184,1458,211"/>
<area shape="rect" id="node27" href="include_2mxnet_2op__attr__types_8h.html" title="mxnet/op_attr_types.h" alt="" coords="2174,333,2343,360"/>
<area shape="rect" id="node28" href="include_2mxnet_2graph__attr__types_8h.html" title="mxnet/graph_attr_types.h" alt="" coords="2225,259,2415,285"/>
</map>
</div>
</div>
<p><a href="exec__utils_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="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacemxnet"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html">mxnet</a></td></tr>
<tr class="memdesc:namespacemxnet"><td class="mdescLeft">&#160;</td><td class="mdescRight">namespace of mxnet <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacemxnet_1_1common"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html">mxnet::common</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a2262a78f3d80b9adeb3b517246fe4335"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#a2262a78f3d80b9adeb3b517246fe4335">mxnet::common::SetupDefaultBlobsIn</a> (const std::vector&lt; NDArray &gt; &amp;src, const std::vector&lt; NDArray &gt; *bufs, std::vector&lt; TBlob &gt; *blobs, std::vector&lt; NDArray &gt; *temp_src, std::vector&lt; NDArray &gt; *temp_dst, std::unordered_map&lt; uint32_t, uint32_t &gt; *idx_map)</td></tr>
<tr class="separator:a2262a78f3d80b9adeb3b517246fe4335"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28bf4d1e9b7392f106950b00de5a2c62"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#a28bf4d1e9b7392f106950b00de5a2c62">mxnet::common::SetupDefaultBlobsOut</a> (const std::vector&lt; NDArray &gt; &amp;src, const std::vector&lt; NDArray &gt; *bufs, std::vector&lt; OpReqType &gt; *req, std::vector&lt; TBlob &gt; *blobs, std::vector&lt; NDArray &gt; *temp_src, std::vector&lt; NDArray &gt; *temp_dst)</td></tr>
<tr class="separator:a28bf4d1e9b7392f106950b00de5a2c62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2dc5d03c700c90be66f47c4f46d2ef6a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#a2dc5d03c700c90be66f47c4f46d2ef6a">mxnet::common::SetupDefaultBlobsInOut</a> (const std::vector&lt; NDArray &gt; &amp;ndinputs, const std::vector&lt; NDArray &gt; &amp;ndoutputs, const std::vector&lt; NDArray &gt; *in_bufs, const std::vector&lt; NDArray &gt; *out_bufs, std::vector&lt; OpReqType &gt; *req, std::vector&lt; TBlob &gt; *input_blobs, std::vector&lt; TBlob &gt; *output_blobs, std::vector&lt; NDArray &gt; *pre_temp_src, std::vector&lt; NDArray &gt; *pre_temp_dst, std::vector&lt; NDArray &gt; *post_temp_src, std::vector&lt; NDArray &gt; *post_temp_dst, std::unordered_map&lt; uint32_t, uint32_t &gt; *in_temp_idx_map, const std::vector&lt; uint32_t &gt; &amp;mutate_idx)</td></tr>
<tr class="separator:a2dc5d03c700c90be66f47c4f46d2ef6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12f6653ed0571a1bc16afdfcf525c841"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#a12f6653ed0571a1bc16afdfcf525c841">mxnet::common::CastNonDefaultStorage</a> (const std::vector&lt; NDArray &gt; &amp;src, const std::vector&lt; NDArray &gt; &amp;dst, const OpContext &amp;ctx, const bool is_gpu)</td></tr>
<tr class="separator:a12f6653ed0571a1bc16afdfcf525c841"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6369bac95f2e7080088927858937d7b0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#a6369bac95f2e7080088927858937d7b0">mxnet::common::SameType</a> (const <a class="el" href="structnnvm_1_1NodeAttrs.html">nnvm::NodeAttrs</a> &amp;attrs, std::vector&lt; int &gt; *iattr, std::vector&lt; int &gt; *oattr)</td></tr>
<tr class="memdesc:a6369bac95f2e7080088927858937d7b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default type inference function, which assigns all undefined types to the same type of one of the inputs or outputs. <a href="namespacemxnet_1_1common.html#a6369bac95f2e7080088927858937d7b0">More...</a><br /></td></tr>
<tr class="separator:a6369bac95f2e7080088927858937d7b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33f2eeb2434d3cdab77227b62ecf3d31"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#a33f2eeb2434d3cdab77227b62ecf3d31">mxnet::common::DefaultStorageType</a> (const <a class="el" href="structnnvm_1_1NodeAttrs.html">nnvm::NodeAttrs</a> &amp;attrs, const int dev_mask, DispatchMode *dispatch_mode, std::vector&lt; int &gt; *iattr, std::vector&lt; int &gt; *oattr)</td></tr>
<tr class="memdesc:a33f2eeb2434d3cdab77227b62ecf3d31"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default storage type inference function, which assigns all undefined storage types to kDefaultStorage. If all of input and output storage types are kDefaultStorage, <a class="el" href="namespacemxnet.html#aad5fec2b4bceabbf4b884460cc2e0a2ba2157864769b54d1d0f8f9be63393e7d6">DispatchMode::kFCompute</a> is assigned to dispatch_mode. Otherwise, <a class="el" href="namespacemxnet.html#aad5fec2b4bceabbf4b884460cc2e0a2ba18bf63b4c196f79c9bca4ad8637e8fef">DispatchMode::kFComputeFallback</a> is assigned to dispatch_mode. <a href="namespacemxnet_1_1common.html#a33f2eeb2434d3cdab77227b62ecf3d31">More...</a><br /></td></tr>
<tr class="separator:a33f2eeb2434d3cdab77227b62ecf3d31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab24b30a630e9ebf963f763a99b48ebc5"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#ab24b30a630e9ebf963f763a99b48ebc5">mxnet::common::storage_str</a> (int storage_id)</td></tr>
<tr class="separator:ab24b30a630e9ebf963f763a99b48ebc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcd04f4664c3f1db116cdf6d86236a87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#abcd04f4664c3f1db116cdf6d86236a87">mxnet::common::LogMemoryPlan</a> (const <a class="el" href="classnnvm_1_1Graph.html">nnvm::Graph</a> &amp;g)</td></tr>
<tr class="separator:abcd04f4664c3f1db116cdf6d86236a87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a497a260b6b4c473e4ad03477f500763e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#a497a260b6b4c473e4ad03477f500763e">mxnet::common::LogInferStorage</a> (const <a class="el" href="classnnvm_1_1Graph.html">nnvm::Graph</a> &amp;g)</td></tr>
<tr class="separator:a497a260b6b4c473e4ad03477f500763e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab31144ebf55a80bf2fbb17d784aacf77"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#ab31144ebf55a80bf2fbb17d784aacf77">mxnet::common::HandleInferShapeError</a> (const size_t num_forward_inputs, const <a class="el" href="classnnvm_1_1IndexedGraph.html">nnvm::IndexedGraph</a> &amp;idx, const <a class="el" href="namespacemxnet.html#a87e1c30aafac389774c6f4d905c0e5ea">mxnet::ShapeVector</a> &amp;inferred_shapes)</td></tr>
<tr class="separator:ab31144ebf55a80bf2fbb17d784aacf77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0a2f5f50d4fdcb21b9cd7d595cba8bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#ad0a2f5f50d4fdcb21b9cd7d595cba8bd">mxnet::common::HandleInferTypeError</a> (const size_t num_forward_inputs, const <a class="el" href="classnnvm_1_1IndexedGraph.html">nnvm::IndexedGraph</a> &amp;idx, const <a class="el" href="namespacennvm.html#af3047555e6bce725a8abba02b4155de9">nnvm::DTypeVector</a> &amp;inferred_dtypes)</td></tr>
<tr class="separator:ad0a2f5f50d4fdcb21b9cd7d595cba8bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ae705382eedf9d523df62d9b9128423"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#a9ae705382eedf9d523df62d9b9128423">mxnet::common::HandleInferStorageTypeError</a> (const size_t num_forward_inputs, const <a class="el" href="classnnvm_1_1IndexedGraph.html">nnvm::IndexedGraph</a> &amp;idx, const StorageTypeVector &amp;inferred_stypes)</td></tr>
<tr class="separator:a9ae705382eedf9d523df62d9b9128423"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02752372972ae43c182e4994df2bddc5"><td class="memItemLeft" align="right" valign="top">NDArray&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#a02752372972ae43c182e4994df2bddc5">mxnet::common::ReshapeOrCreate</a> (const std::string &amp;name, const <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &amp;dest_arg_shape, const int dest_arg_dtype, const NDArrayStorageType dest_arg_stype, const Context &amp;ctx, std::unordered_map&lt; std::string, NDArray &gt; *shared_buffer, bool enable_row_sparse_sharing)</td></tr>
<tr class="memdesc:a02752372972ae43c182e4994df2bddc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the requested ndarray's shape size is less than the corresponding shared_data_array's shape size and the storage type is shareable, reuse the memory allocation in shared_buffer; otherwise, create a zero ndarray. Shareable storages include both default storage and row_sparse storage if enable_row_sparse_sharing is <code>True</code>, otherwise default storage only. <a href="namespacemxnet_1_1common.html#a02752372972ae43c182e4994df2bddc5">More...</a><br /></td></tr>
<tr class="separator:a02752372972ae43c182e4994df2bddc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19bebfe40260d14068675b893f6b1a6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnnvm_1_1Graph.html">nnvm::Graph</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#a19bebfe40260d14068675b893f6b1a6b">mxnet::common::AssignContext</a> (<a class="el" href="classnnvm_1_1Graph.html">nnvm::Graph</a> g, const Context &amp;default_ctx, const std::map&lt; std::string, Context &gt; &amp;ctx_map, const std::vector&lt; Context &gt; &amp;in_arg_ctxes, const std::vector&lt; Context &gt; &amp;arg_grad_ctxes, const std::vector&lt; Context &gt; &amp;aux_state_ctxes, const std::vector&lt; OpReqType &gt; &amp;grad_req_types, size_t num_forward_inputs, size_t num_forward_outputs)</td></tr>
<tr class="memdesc:a19bebfe40260d14068675b893f6b1a6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assign context to the graph. This is triggered by both simple_bind and bind flows. <a href="namespacemxnet_1_1common.html#a19bebfe40260d14068675b893f6b1a6b">More...</a><br /></td></tr>
<tr class="separator:a19bebfe40260d14068675b893f6b1a6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d835d88a602aa1b8569b70f1d11e934"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#a9d835d88a602aa1b8569b70f1d11e934">mxnet::common::CopyGraph</a> (<a class="el" href="classnnvm_1_1Graph.html">nnvm::Graph</a> *dst, const <a class="el" href="classnnvm_1_1Graph.html">nnvm::Graph</a> &amp;src, bool copy_variables)</td></tr>
<tr class="memdesc:a9d835d88a602aa1b8569b70f1d11e934"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy the graph, optionally leaving original Variable nodes. <a href="namespacemxnet_1_1common.html#a9d835d88a602aa1b8569b70f1d11e934">More...</a><br /></td></tr>
<tr class="separator:a9d835d88a602aa1b8569b70f1d11e934"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b4aa6dc54114ba01a1451be63a63e18"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html#a6b4aa6dc54114ba01a1451be63a63e18">mxnet::common::CheckForInputNameDuplicates</a> (const <a class="el" href="classnnvm_1_1IndexedGraph.html">nnvm::IndexedGraph</a> &amp;idx)</td></tr>
<tr class="memdesc:a6b4aa6dc54114ba01a1451be63a63e18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether graph contains any duplicated names in its inputs. <a href="namespacemxnet_1_1common.html#a6b4aa6dc54114ba01a1451be63a63e18">More...</a><br /></td></tr>
<tr class="separator:a6b4aa6dc54114ba01a1451be63a63e18"><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>Common utility functions for executors. </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 &#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>