blob: dc22bdc4cb6568fbd43cd246c32356ced8a74369 [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: dnnl_softmax_desc_t 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structdnnl__softmax__desc__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dnnl_softmax_desc_t Struct Reference<div class="ingroups"><a class="el" href="group__dnnl__api.html">Dnnl_api</a> &raquo; <a class="el" href="group__dnnl__api__primitives.html">Dnnl_api_primitives</a> &raquo; <a class="el" href="group__dnnl__api__softmax.html">Dnnl_api_softmax</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A descriptor of a Softmax operation.
<a href="structdnnl__softmax__desc__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="oneapi_2dnnl_2dnnl__types_8h_source.html">dnnl_types.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for dnnl_softmax_desc_t:</div>
<div class="dyncontent">
<div class="center"><img src="structdnnl__softmax__desc__t__coll__graph.png" border="0" usemap="#dnnl__softmax__desc__t_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</div>
<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:aada503f0c7cd766680d6a8720993b108"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__primitives__common.html#ga9878f4795e53ad8443e5c0a29e53286a">dnnl_primitive_kind_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__softmax__desc__t.html#aada503f0c7cd766680d6a8720993b108">primitive_kind</a></td></tr>
<tr class="separator:aada503f0c7cd766680d6a8720993b108"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63ef3b7d75b3870d50cb209e0a265e47"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__primitives__common.html#gae3c1f22ae55645782923fbfd8b07d0c4">dnnl_prop_kind_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__softmax__desc__t.html#a63ef3b7d75b3870d50cb209e0a265e47">prop_kind</a></td></tr>
<tr class="separator:a63ef3b7d75b3870d50cb209e0a265e47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf2142a8799e960f8cb14bd661739ea8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__softmax__desc__t.html#abf2142a8799e960f8cb14bd661739ea8">data_desc</a></td></tr>
<tr class="memdesc:abf2142a8799e960f8cb14bd661739ea8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source and destination memory descriptor. <a href="structdnnl__softmax__desc__t.html#abf2142a8799e960f8cb14bd661739ea8">More...</a><br /></td></tr>
<tr class="separator:abf2142a8799e960f8cb14bd661739ea8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affbec0ec38fb9093bad14be278a11874"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__softmax__desc__t.html#affbec0ec38fb9093bad14be278a11874">diff_desc</a></td></tr>
<tr class="memdesc:affbec0ec38fb9093bad14be278a11874"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source and Destination of gradient memory descriptor. <a href="structdnnl__softmax__desc__t.html#affbec0ec38fb9093bad14be278a11874">More...</a><br /></td></tr>
<tr class="separator:affbec0ec38fb9093bad14be278a11874"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2923dc4fc7bea2fe6bf0745de54bffd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__softmax__desc__t.html#ae2923dc4fc7bea2fe6bf0745de54bffd">softmax_axis</a></td></tr>
<tr class="memdesc:ae2923dc4fc7bea2fe6bf0745de54bffd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The axis along which to perform the softmax. <a href="structdnnl__softmax__desc__t.html#ae2923dc4fc7bea2fe6bf0745de54bffd">More...</a><br /></td></tr>
<tr class="separator:ae2923dc4fc7bea2fe6bf0745de54bffd"><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 descriptor of a Softmax operation. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="abf2142a8799e960f8cb14bd661739ea8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf2142a8799e960f8cb14bd661739ea8">&#9670;&nbsp;</a></span>data_desc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> dnnl_softmax_desc_t::data_desc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Source and destination memory descriptor. </p>
</div>
</div>
<a id="affbec0ec38fb9093bad14be278a11874"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affbec0ec38fb9093bad14be278a11874">&#9670;&nbsp;</a></span>diff_desc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> dnnl_softmax_desc_t::diff_desc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Source and Destination of gradient memory descriptor. </p>
</div>
</div>
<a id="aada503f0c7cd766680d6a8720993b108"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aada503f0c7cd766680d6a8720993b108">&#9670;&nbsp;</a></span>primitive_kind</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__dnnl__api__primitives__common.html#ga9878f4795e53ad8443e5c0a29e53286a">dnnl_primitive_kind_t</a> dnnl_softmax_desc_t::primitive_kind</td>
</tr>
</table>
</div><div class="memdoc">
<p>The kind of primitive. Used for self-identifying the primitive descriptor. Must be <a class="el" href="group__dnnl__api__primitives__common.html#gga9878f4795e53ad8443e5c0a29e53286aad6c6b37d892628e2b869669557d0098e" title="A softmax primitive.">dnnl_softmax</a>. </p>
</div>
</div>
<a id="a63ef3b7d75b3870d50cb209e0a265e47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63ef3b7d75b3870d50cb209e0a265e47">&#9670;&nbsp;</a></span>prop_kind</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__dnnl__api__primitives__common.html#gae3c1f22ae55645782923fbfd8b07d0c4">dnnl_prop_kind_t</a> dnnl_softmax_desc_t::prop_kind</td>
</tr>
</table>
</div><div class="memdoc">
<p>The kind of propagation. Possible values: <a class="el" href="group__dnnl__api__primitives__common.html#ggae3c1f22ae55645782923fbfd8b07d0c4a992e03bebfe623ac876b3636333bbce0">dnnl_forward_training</a>, <a class="el" href="group__dnnl__api__primitives__common.html#ggae3c1f22ae55645782923fbfd8b07d0c4a2f77a568a675dec649eb0450c997856d">dnnl_forward_inference</a>, and <a class="el" href="group__dnnl__api__primitives__common.html#ggae3c1f22ae55645782923fbfd8b07d0c4a524dd6cb2ed9680bbd170ba15261d218" title="Backward data propagation.">dnnl_backward_data</a>. </p>
</div>
</div>
<a id="ae2923dc4fc7bea2fe6bf0745de54bffd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2923dc4fc7bea2fe6bf0745de54bffd">&#9670;&nbsp;</a></span>softmax_axis</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dnnl_softmax_desc_t::softmax_axis</td>
</tr>
</table>
</div><div class="memdoc">
<p>The axis along which to perform the softmax. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/include/onednn/oneapi/dnnl/<a class="el" href="oneapi_2dnnl_2dnnl__types_8h_source.html">dnnl_types.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:40 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>