Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / 1.9.1 / api / cpp / docs / api / structdnnl__layer__normalization__desc__t.html
blob: b81773629079aaa862c3dde75e5401cbd8f24136 [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: dnnl_layer_normalization_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.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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structdnnl__layer__normalization__desc__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dnnl_layer_normalization_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__layer__normalization.html">Dnnl_api_layer_normalization</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A descriptor of a Layer Normalization operation.
<a href="structdnnl__layer__normalization__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_layer_normalization_desc_t:</div>
<div class="dyncontent">
<div class="center"><img src="structdnnl__layer__normalization__desc__t__coll__graph.png" border="0" usemap="#dnnl__layer__normalization__desc__t_coll__map" alt="Collaboration graph"/></div>
<map name="dnnl__layer__normalization__desc__t_coll__map" id="dnnl__layer__normalization__desc__t_coll__map">
<area shape="rect" id="node2" href="structdnnl__memory__desc__t.html" title="{dnnl_memory_desc_t\n|+ ndims\l+ dims\l+ data_type\l+ padded_dims\l+ padded_offsets\l+ offset0\l+ format_kind\l+ format_desc\l|}" alt="" coords="264,292,425,472"/>
<area shape="rect" id="node3" href="structdnnl__wino__desc__t.html" title="Description of tensor of weights for winograd 2x3 convolution. " alt="" coords="5,5,143,229"/>
<area shape="rect" id="node4" href="structdnnl__blocking__desc__t.html" title="{dnnl_blocking_desc_t\n|+ strides\l+ inner_nblks\l+ inner_blks\l+ inner_idxs\l|}" alt="" coords="167,57,328,178"/>
<area shape="rect" id="node5" href="structdnnl__rnn__packed__desc__t.html" title="Description of tensor of packed weights for rnn. " alt="" coords="353,13,534,222"/>
<area shape="rect" id="node6" href="structdnnl__memory__extra__desc__t.html" title="Description of extra information stored in memory. " alt="" coords="559,49,787,185"/>
</map>
</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:a91a36772ae6a9c48316ff41458cadcf4"><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__layer__normalization__desc__t.html#a91a36772ae6a9c48316ff41458cadcf4">primitive_kind</a></td></tr>
<tr class="separator:a91a36772ae6a9c48316ff41458cadcf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15480bc3b7ef17d6d151258b7a751dca"><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__layer__normalization__desc__t.html#a15480bc3b7ef17d6d151258b7a751dca">prop_kind</a></td></tr>
<tr class="separator:a15480bc3b7ef17d6d151258b7a751dca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af974f20608c034176e52d3f697964cd0"><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__layer__normalization__desc__t.html#af974f20608c034176e52d3f697964cd0">data_desc</a></td></tr>
<tr class="memdesc:af974f20608c034176e52d3f697964cd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source and destination memory descriptor. <a href="#af974f20608c034176e52d3f697964cd0">More...</a><br /></td></tr>
<tr class="separator:af974f20608c034176e52d3f697964cd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02923a3207c9d4ddc7355b967a096f35"><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__layer__normalization__desc__t.html#a02923a3207c9d4ddc7355b967a096f35">diff_data_desc</a></td></tr>
<tr class="memdesc:a02923a3207c9d4ddc7355b967a096f35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source and destination gradient memory descriptor. <a href="#a02923a3207c9d4ddc7355b967a096f35">More...</a><br /></td></tr>
<tr class="separator:a02923a3207c9d4ddc7355b967a096f35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a341586c80c38296776322fce413d159c"><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__layer__normalization__desc__t.html#a341586c80c38296776322fce413d159c">data_scaleshift_desc</a></td></tr>
<tr class="separator:a341586c80c38296776322fce413d159c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a677acbe1322ae82a2877f288c8da528d"><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__layer__normalization__desc__t.html#a677acbe1322ae82a2877f288c8da528d">diff_data_scaleshift_desc</a></td></tr>
<tr class="separator:a677acbe1322ae82a2877f288c8da528d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4cde3388ff942b1410ca143ccb010d1"><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__layer__normalization__desc__t.html#aa4cde3388ff942b1410ca143ccb010d1">stat_desc</a></td></tr>
<tr class="separator:aa4cde3388ff942b1410ca143ccb010d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b91b83b4fd696879a817dded69ab737"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__layer__normalization__desc__t.html#a3b91b83b4fd696879a817dded69ab737">layer_norm_epsilon</a></td></tr>
<tr class="memdesc:a3b91b83b4fd696879a817dded69ab737"><td class="mdescLeft">&#160;</td><td class="mdescRight">Layer normalization epsilon parameter. <a href="#a3b91b83b4fd696879a817dded69ab737">More...</a><br /></td></tr>
<tr class="separator:a3b91b83b4fd696879a817dded69ab737"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a070cb38389b0c0c3434f8f48cf7c9f48"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__layer__normalization__desc__t.html#a070cb38389b0c0c3434f8f48cf7c9f48">flags</a></td></tr>
<tr class="separator:a070cb38389b0c0c3434f8f48cf7c9f48"><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 Layer Normalization operation. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="af974f20608c034176e52d3f697964cd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af974f20608c034176e52d3f697964cd0">&#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_layer_normalization_desc_t::data_desc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Source and destination memory descriptor. </p>
</div>
</div>
<a id="a341586c80c38296776322fce413d159c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a341586c80c38296776322fce413d159c">&#9670;&nbsp;</a></span>data_scaleshift_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_layer_normalization_desc_t::data_scaleshift_desc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Scale and shift data and gradient memory descriptors.</p>
<p>Scaleshift memory descriptor uses 2D <a class="el" href="group__dnnl__api__memory.html#gga395e42b594683adb25ed2d842bb3091da1bd907fc29344dfe7ba88336960dcf53" title="plain 2D tensor ">dnnl_ab</a> format[2, normalized_dim] where 1-st dimension contains gamma parameter, 2-nd dimension contains beta parameter. Normalized_dim is equal to the last logical dimension of the data tensor across which normalization is performed. </p>
</div>
</div>
<a id="a02923a3207c9d4ddc7355b967a096f35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02923a3207c9d4ddc7355b967a096f35">&#9670;&nbsp;</a></span>diff_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_layer_normalization_desc_t::diff_data_desc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Source and destination gradient memory descriptor. </p>
</div>
</div>
<a id="a677acbe1322ae82a2877f288c8da528d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a677acbe1322ae82a2877f288c8da528d">&#9670;&nbsp;</a></span>diff_data_scaleshift_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_layer_normalization_desc_t::diff_data_scaleshift_desc</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a070cb38389b0c0c3434f8f48cf7c9f48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a070cb38389b0c0c3434f8f48cf7c9f48">&#9670;&nbsp;</a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned dnnl_layer_normalization_desc_t::flags</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3b91b83b4fd696879a817dded69ab737"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b91b83b4fd696879a817dded69ab737">&#9670;&nbsp;</a></span>layer_norm_epsilon</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float dnnl_layer_normalization_desc_t::layer_norm_epsilon</td>
</tr>
</table>
</div><div class="memdoc">
<p>Layer normalization epsilon parameter. </p>
</div>
</div>
<a id="a91a36772ae6a9c48316ff41458cadcf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91a36772ae6a9c48316ff41458cadcf4">&#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_layer_normalization_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#gga9878f4795e53ad8443e5c0a29e53286aa8fe4eac2a079b1278abbc80cf0d90aff" title="A layer normalization primitive. ">dnnl_layer_normalization</a>. </p>
</div>
</div>
<a id="a15480bc3b7ef17d6d151258b7a751dca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15480bc3b7ef17d6d151258b7a751dca">&#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_layer_normalization_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>, <a class="el" href="group__dnnl__api__primitives__common.html#ggae3c1f22ae55645782923fbfd8b07d0c4a326a5e31769302972e7bded555e1cc10" title="Backward propagation (with respect to all parameters). ">dnnl_backward</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="aa4cde3388ff942b1410ca143ccb010d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4cde3388ff942b1410ca143ccb010d1">&#9670;&nbsp;</a></span>stat_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_layer_normalization_desc_t::stat_desc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Mean and variance data memory descriptors.</p>
<p>Statistics (mean and variance) memory descriptor is the k-dimensional tensor where k is equal to data_tensor_ndims - 1 and may have any plain (stride[last_dim] == 1) user-provided format. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/include/mkldnn/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 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>