blob: 1703cfa3dd34b73a43a3bb35c037d168406a2c86 [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.11"/>
<title>mxnet: Queries</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>
<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 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.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Queries<div class="ingroups"><a class="el" href="group__c__api.html">C API</a> &raquo; <a class="el" href="group__c__api__types.html">Types</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Queries:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__c__api__types__query.png" border="0" alt="" usemap="#group____c____api____types____query"/>
<map name="group____c____api____types____query" id="group____c____api____types____query">
<area shape="rect" id="node1" href="group__c__api__types.html" title="Types" alt="" coords="5,5,63,32"/>
</map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga6eebc661a8a3437b49d9c677f8972fc9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__types__query.html#ga6eebc661a8a3437b49d9c677f8972fc9">mkldnn_query_t</a> { <br />
&#160;&#160;<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9ac342bd96b1dcf20bfdd07176d87fc3b1">mkldnn_query_undef</a> = 0,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9ac71b9911ec94b71ea2e98e744d614f5b">mkldnn_query_engine</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a45d1398d4d2b05d009de94f05d7cf267">mkldnn_query_primitive_kind</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a660e903603b99e5745feba14a7ee2891">mkldnn_query_num_of_inputs_s32</a>,
<br />
&#160;&#160;<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9abd7a52122733cac8b3d1de8eab20f9cf">mkldnn_query_num_of_outputs_s32</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a052bcf260d366f5da76eda4cd807d5a3">mkldnn_query_time_estimate_f64</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a1224b5177cb23277aab6f3ba17427d25">mkldnn_query_memory_consumption_s64</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9ae59d275ad2270361bc9bea0cbd60efe4">mkldnn_query_scratchpad_engine</a>,
<br />
&#160;&#160;<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9ab92f503404fade1f402bed9c34727d9c">mkldnn_query_impl_info_str</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a6e663244b7f359919db4b5941b63221a">mkldnn_query_some_d</a> = 64,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a04f941d8d190227e583d1fe7f4a6e5d3">mkldnn_query_op_d</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a3e1f5ad4718ad7f41916b4227e0a9964">mkldnn_query_convolution_d</a>,
<br />
&#160;&#160;<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a43c69ed45016096444979bd659b13933">mkldnn_query_deconvolution_d</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a2d00a3fff5439f0b965336c7c29774f0">mkldnn_query_shuffle_d</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a6ea3ff9ae6be79fe71a89bbfc87b4d7e">mkldnn_query_eltwise_d</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9ab9907d7aa54e335ee653649347f3d8c2">mkldnn_query_softmax_d</a>,
<br />
&#160;&#160;<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a0623ff58865a6d4e3a1a3cda27a563dd">mkldnn_query_pooling_d</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a8cd41fba74cf7a570ae98e03e22f9043">mkldnn_query_lrn_d</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a2d5736954ae78ef9e2cf4e354829e874">mkldnn_query_batch_normalization_d</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a079af104c4c7cd8de5833316e137fa03">mkldnn_query_inner_product_d</a>,
<br />
&#160;&#160;<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a7a567d8e61a6e0b1aeb219f5229b13de">mkldnn_query_rnn_d</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a2c91434adbb5f4f039fb01ac3065a2c9">mkldnn_query_gemm_d</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9aea0f2677b5b41fa8ff2222b4d7ca9ab9">mkldnn_query_some_md</a> = 128,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a2bccd0a79be2c331227c353c294c3fbc">mkldnn_query_src_md</a>,
<br />
&#160;&#160;<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9ad915503c92000da20088fdb93cd685b9">mkldnn_query_diff_src_md</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a4d1661d6a50277029d02417f6b65435d">mkldnn_query_weights_md</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a2c78f7a683101ff96875e8cec787ba42">mkldnn_query_diff_weights_md</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9adccda04151e0c287f0de64b832d33ac4">mkldnn_query_dst_md</a>,
<br />
&#160;&#160;<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9acfa30e38738b3de8c7d3a7f21ffc1623">mkldnn_query_diff_dst_md</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a6f61e139512317e7f5653759e889d55d">mkldnn_query_workspace_md</a>,
<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a543d6dbebcadbf810f2a9d2ccbcd21be">mkldnn_query_scratchpad_md</a>
<br />
}</td></tr>
<tr class="separator:ga6eebc661a8a3437b49d9c677f8972fc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga6eebc661a8a3437b49d9c677f8972fc9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__c__api__types__query.html#ga6eebc661a8a3437b49d9c677f8972fc9">mkldnn_query_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Primitive descriptor query specification</p>
<p>For generic function <a class="el" href="group__c__api__primitive__common.html#gaa0ef4b91ed5cd98a19540a8182228012">mkldnn_primitive_desc_query()</a>, the type of result must agree with the queried argument. The correspondence table: </p><h2>Query | type of result </h2>
<p><a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9ac71b9911ec94b71ea2e98e744d614f5b" title="execution engine ">mkldnn_query_engine</a> | mkldnn_engine_t * <a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9ae59d275ad2270361bc9bea0cbd60efe4">mkldnn_query_scratchpad_engine</a> | mkldnn_engine_t * <a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a45d1398d4d2b05d009de94f05d7cf267" title="primitive kind ">mkldnn_query_primitive_kind</a> | mkldnn_primitive_kind_t * *_s32 | int * *_s64 | mkldnn_dim_t * (same as int64_t *) *_f64 | double * *_str | const char ** <a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a04f941d8d190227e583d1fe7f4a6e5d3" title="op descriptor ">mkldnn_query_op_d</a> | const_mkldnn_op_desc_t * *_md | const <a class="el" href="structmkldnn__memory__desc__t.html">mkldnn_memory_desc_t</a> ** *_${op}_d | const mkldnn_${op}_desc_t ** *_pd | const_mkldnn_primitive_desc_t *</p>
<dl class="section note"><dt>Note</dt><dd>Rule of thumb: all opaque types and structures are returned by reference. All numbers are returned by value.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>All returned references point to constant objects and are valid only during the lifetime of the queried primitive descriptor. Returned objects must not be destroyed by the user. If you need to keep the object longer than the lifetime of the queried primitive descriptor, use <a class="el" href="group__c__api__primitive__common.html#ga0b9555bd267ce2add362ee18cdaadd73" title="Makes a copy of a primitive_desc. ">mkldnn_primitive_desc_clone()</a> to make a copy. </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9ac342bd96b1dcf20bfdd07176d87fc3b1"></a>mkldnn_query_undef&#160;</td><td class="fielddoc">
<p>no query </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9ac71b9911ec94b71ea2e98e744d614f5b"></a>mkldnn_query_engine&#160;</td><td class="fielddoc">
<p>execution engine </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a45d1398d4d2b05d009de94f05d7cf267"></a>mkldnn_query_primitive_kind&#160;</td><td class="fielddoc">
<p>primitive kind </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a660e903603b99e5745feba14a7ee2891"></a>mkldnn_query_num_of_inputs_s32&#160;</td><td class="fielddoc">
<p>number of inputs expected </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9abd7a52122733cac8b3d1de8eab20f9cf"></a>mkldnn_query_num_of_outputs_s32&#160;</td><td class="fielddoc">
<p>number of outputs expected </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a052bcf260d366f5da76eda4cd807d5a3"></a>mkldnn_query_time_estimate_f64&#160;</td><td class="fielddoc">
<p>runtime estimation (seconds) </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a1224b5177cb23277aab6f3ba17427d25"></a>mkldnn_query_memory_consumption_s64&#160;</td><td class="fielddoc">
<p>memory consumption &ndash; extra (scratch) memory, additional to all inputs and outputs memory (bytes) </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9ae59d275ad2270361bc9bea0cbd60efe4"></a>mkldnn_query_scratchpad_engine&#160;</td><td class="fielddoc">
<p>scratchpad engine &ndash; engine to be used for creating scratchpad memory </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9ab92f503404fade1f402bed9c34727d9c"></a>mkldnn_query_impl_info_str&#160;</td><td class="fielddoc">
<p>implementation name </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a6e663244b7f359919db4b5941b63221a"></a>mkldnn_query_some_d&#160;</td><td class="fielddoc">
<p>stub </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a04f941d8d190227e583d1fe7f4a6e5d3"></a>mkldnn_query_op_d&#160;</td><td class="fielddoc">
<p>op descriptor </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a3e1f5ad4718ad7f41916b4227e0a9964"></a>mkldnn_query_convolution_d&#160;</td><td class="fielddoc">
<p>convolution descriptor </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a43c69ed45016096444979bd659b13933"></a>mkldnn_query_deconvolution_d&#160;</td><td class="fielddoc">
<p>deconvolution descriptor </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a2d00a3fff5439f0b965336c7c29774f0"></a>mkldnn_query_shuffle_d&#160;</td><td class="fielddoc">
<p>shuffle descriptor </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a6ea3ff9ae6be79fe71a89bbfc87b4d7e"></a>mkldnn_query_eltwise_d&#160;</td><td class="fielddoc">
<p>eltwise descriptor </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9ab9907d7aa54e335ee653649347f3d8c2"></a>mkldnn_query_softmax_d&#160;</td><td class="fielddoc">
<p>softmax descriptor </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a0623ff58865a6d4e3a1a3cda27a563dd"></a>mkldnn_query_pooling_d&#160;</td><td class="fielddoc">
<p>pooling descriptor </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a8cd41fba74cf7a570ae98e03e22f9043"></a>mkldnn_query_lrn_d&#160;</td><td class="fielddoc">
<p>lrn descriptor </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a2d5736954ae78ef9e2cf4e354829e874"></a>mkldnn_query_batch_normalization_d&#160;</td><td class="fielddoc">
<p>batch normalization descriptor </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a079af104c4c7cd8de5833316e137fa03"></a>mkldnn_query_inner_product_d&#160;</td><td class="fielddoc">
<p>inner product descriptor </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a7a567d8e61a6e0b1aeb219f5229b13de"></a>mkldnn_query_rnn_d&#160;</td><td class="fielddoc">
<p>rnn descriptor </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a2c91434adbb5f4f039fb01ac3065a2c9"></a>mkldnn_query_gemm_d&#160;</td><td class="fielddoc">
<p>GEMM descriptor. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9aea0f2677b5b41fa8ff2222b4d7ca9ab9"></a>mkldnn_query_some_md&#160;</td><td class="fielddoc">
<p>stub </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a2bccd0a79be2c331227c353c294c3fbc"></a>mkldnn_query_src_md&#160;</td><td class="fielddoc">
<p>source memory desc </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9ad915503c92000da20088fdb93cd685b9"></a>mkldnn_query_diff_src_md&#160;</td><td class="fielddoc">
<p>source gradient memory desc </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a4d1661d6a50277029d02417f6b65435d"></a>mkldnn_query_weights_md&#160;</td><td class="fielddoc">
<p>weights memory descriptor desc </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a2c78f7a683101ff96875e8cec787ba42"></a>mkldnn_query_diff_weights_md&#160;</td><td class="fielddoc">
<p>weights grad. memory desc </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9adccda04151e0c287f0de64b832d33ac4"></a>mkldnn_query_dst_md&#160;</td><td class="fielddoc">
<p>destination memory desc </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9acfa30e38738b3de8c7d3a7f21ffc1623"></a>mkldnn_query_diff_dst_md&#160;</td><td class="fielddoc">
<p>destination grad. memory desc </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a6f61e139512317e7f5653759e889d55d"></a>mkldnn_query_workspace_md&#160;</td><td class="fielddoc">
<p>workspace memory desc </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga6eebc661a8a3437b49d9c677f8972fc9a543d6dbebcadbf810f2a9d2ccbcd21be"></a>mkldnn_query_scratchpad_md&#160;</td><td class="fielddoc">
<p>scratchpad memory desc </p>
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Mar 28 2020 00:52:31 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>