Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / refs/heads/gh-pages / . / 24.02 / structarmnn_1_1_batch_normalization_descriptor.html
blob: 9a7e8f671ec20da88ed2460d6d265ab3abfb0867 [file] [log] [blame]
Nikhil Raj38b600d2024-02-15 15:02:19 +0000[diff] [blame]1<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: BatchNormalizationDescriptor Struct Reference</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.02</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('structarmnn_1_1_batch_normalization_descriptor.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="summary">
96<a href="#pub-methods">Public Member Functions</a> &#124;
97<a href="#pub-attribs">Public Attributes</a> &#124;
98<a href="structarmnn_1_1_batch_normalization_descriptor-members.html">List of all members</a> </div>
99 <div class="headertitle">
100<div class="title">BatchNormalizationDescriptor Struct Reference</div> </div>
101</div><!--header-->
102<div class="contents">
103
104<p>A <a class="el" href="structarmnn_1_1_batch_normalization_descriptor.html" title="A BatchNormalizationDescriptor for the BatchNormalizationLayer.">BatchNormalizationDescriptor</a> for the <a class="el" href="classarmnn_1_1_batch_normalization_layer.html" title="This layer represents a batch normalization operation.">BatchNormalizationLayer</a>.
105 <a href="structarmnn_1_1_batch_normalization_descriptor.html#details">More...</a></p>
106
107<p><code>#include &lt;<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>&gt;</code></p>
108<div class="dynheader">
109Inheritance diagram for BatchNormalizationDescriptor:</div>
110<div class="dyncontent">
111<div class="center"><iframe scrolling="no" frameborder="0" src="structarmnn_1_1_batch_normalization_descriptor__inherit__graph.svg" width="230" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
112</div>
113<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
114<div class="dynheader">
115Collaboration diagram for BatchNormalizationDescriptor:</div>
116<div class="dyncontent">
117<div class="center"><iframe scrolling="no" frameborder="0" src="structarmnn_1_1_batch_normalization_descriptor__coll__graph.svg" width="230" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
118</div>
119<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
120<table class="memberdecls">
121<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
122Public Member Functions</h2></td></tr>
123<tr class="memitem:aefba12eed94174fb6eaeb78b6eaf7e59"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_batch_normalization_descriptor.html#aefba12eed94174fb6eaeb78b6eaf7e59">BatchNormalizationDescriptor</a> ()</td></tr>
124<tr class="separator:aefba12eed94174fb6eaeb78b6eaf7e59"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<tr class="memitem:a65f4f175144b079a9b33eb4871192af6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_batch_normalization_descriptor.html#a65f4f175144b079a9b33eb4871192af6">operator==</a> (const <a class="el" href="structarmnn_1_1_batch_normalization_descriptor.html">BatchNormalizationDescriptor</a> &amp;rhs) const</td></tr>
126<tr class="separator:a65f4f175144b079a9b33eb4871192af6"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="inherit_header pub_methods_structarmnn_1_1_base_descriptor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structarmnn_1_1_base_descriptor')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structarmnn_1_1_base_descriptor.html">BaseDescriptor</a></td></tr>
128<tr class="memitem:ac618666b3c6d65d2c88bcbb7abeed343 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_base_descriptor.html#ac618666b3c6d65d2c88bcbb7abeed343">IsNull</a> () const</td></tr>
129<tr class="separator:ac618666b3c6d65d2c88bcbb7abeed343 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
130<tr class="memitem:a5e0f82ef2f18eb897e6d6f1845e74033 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_base_descriptor.html#a5e0f82ef2f18eb897e6d6f1845e74033">~BaseDescriptor</a> ()=default</td></tr>
131<tr class="separator:a5e0f82ef2f18eb897e6d6f1845e74033 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
132</table><table class="memberdecls">
133<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
134Public Attributes</h2></td></tr>
135<tr class="memitem:a11c821c7524251004a72ed13c510853c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_batch_normalization_descriptor.html#a11c821c7524251004a72ed13c510853c">m_Eps</a></td></tr>
136<tr class="memdesc:a11c821c7524251004a72ed13c510853c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value to add to the variance. Used to avoid dividing by zero. <a href="structarmnn_1_1_batch_normalization_descriptor.html#a11c821c7524251004a72ed13c510853c">More...</a><br /></td></tr>
137<tr class="separator:a11c821c7524251004a72ed13c510853c"><td class="memSeparator" colspan="2">&#160;</td></tr>
138<tr class="memitem:a6089e1ca91914015777ea780a513131a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0">DataLayout</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_batch_normalization_descriptor.html#a6089e1ca91914015777ea780a513131a">m_DataLayout</a></td></tr>
139<tr class="memdesc:a6089e1ca91914015777ea780a513131a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The data layout to be used (NCHW, NHWC). <a href="structarmnn_1_1_batch_normalization_descriptor.html#a6089e1ca91914015777ea780a513131a">More...</a><br /></td></tr>
140<tr class="separator:a6089e1ca91914015777ea780a513131a"><td class="memSeparator" colspan="2">&#160;</td></tr>
141</table>
142<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
143<div class="textblock"><p>A <a class="el" href="structarmnn_1_1_batch_normalization_descriptor.html" title="A BatchNormalizationDescriptor for the BatchNormalizationLayer.">BatchNormalizationDescriptor</a> for the <a class="el" href="classarmnn_1_1_batch_normalization_layer.html" title="This layer represents a batch normalization operation.">BatchNormalizationLayer</a>. </p>
144
145<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00828">828</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
146</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
147<a id="aefba12eed94174fb6eaeb78b6eaf7e59"></a>
148<h2 class="memtitle"><span class="permalink"><a href="#aefba12eed94174fb6eaeb78b6eaf7e59">&#9670;&nbsp;</a></span>BatchNormalizationDescriptor()</h2>
149
150<div class="memitem">
151<div class="memproto">
152<table class="mlabels">
153 <tr>
154 <td class="mlabels-left">
155 <table class="memname">
156 <tr>
157 <td class="memname"><a class="el" href="structarmnn_1_1_batch_normalization_descriptor.html">BatchNormalizationDescriptor</a> </td>
158 <td>(</td>
159 <td class="paramname"></td><td>)</td>
160 <td></td>
161 </tr>
162 </table>
163 </td>
164 <td class="mlabels-right">
165<span class="mlabels"><span class="mlabel">inline</span></span> </td>
166 </tr>
167</table>
168</div><div class="memdoc">
169
170<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00830">830</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
171<div class="fragment"><div class="line"><a name="l00831"></a><span class="lineno"> 831</span>&#160; : <a class="code" href="structarmnn_1_1_batch_normalization_descriptor.html#a11c821c7524251004a72ed13c510853c">m_Eps</a>(0.0001f)</div>
172<div class="line"><a name="l00832"></a><span class="lineno"> 832</span>&#160; , <a class="code" href="structarmnn_1_1_batch_normalization_descriptor.html#a6089e1ca91914015777ea780a513131a">m_DataLayout</a>(<a class="code" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">DataLayout::NCHW</a>)</div>
173<div class="line"><a name="l00833"></a><span class="lineno"> 833</span>&#160; {}</div>
174</div><!-- fragment -->
175<p class="reference">References <a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::NCHW</a>.</p>
176
177</div>
178</div>
179<h2 class="groupheader">Member Function Documentation</h2>
180<a id="a65f4f175144b079a9b33eb4871192af6"></a>
181<h2 class="memtitle"><span class="permalink"><a href="#a65f4f175144b079a9b33eb4871192af6">&#9670;&nbsp;</a></span>operator==()</h2>
182
183<div class="memitem">
184<div class="memproto">
185<table class="mlabels">
186 <tr>
187 <td class="mlabels-left">
188 <table class="memname">
189 <tr>
190 <td class="memname">bool operator== </td>
191 <td>(</td>
192 <td class="paramtype">const <a class="el" href="structarmnn_1_1_batch_normalization_descriptor.html">BatchNormalizationDescriptor</a> &amp;&#160;</td>
193 <td class="paramname"><em>rhs</em></td><td>)</td>
194 <td> const</td>
195 </tr>
196 </table>
197 </td>
198 <td class="mlabels-right">
199<span class="mlabels"><span class="mlabel">inline</span></span> </td>
200 </tr>
201</table>
202</div><div class="memdoc">
203
204<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00835">835</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
205<div class="fragment"><div class="line"><a name="l00836"></a><span class="lineno"> 836</span>&#160; {</div>
206<div class="line"><a name="l00837"></a><span class="lineno"> 837</span>&#160; <span class="keywordflow">return</span> <a class="code" href="structarmnn_1_1_batch_normalization_descriptor.html#a11c821c7524251004a72ed13c510853c">m_Eps</a> == rhs.m_Eps &amp;&amp; <a class="code" href="structarmnn_1_1_batch_normalization_descriptor.html#a6089e1ca91914015777ea780a513131a">m_DataLayout</a> == rhs.m_DataLayout;</div>
207<div class="line"><a name="l00838"></a><span class="lineno"> 838</span>&#160; }</div>
208</div><!-- fragment -->
209<p class="reference">References <a class="el" href="_descriptors_8hpp_source.html#l00843">BatchNormalizationDescriptor::m_DataLayout</a>, and <a class="el" href="_descriptors_8hpp_source.html#l00841">BatchNormalizationDescriptor::m_Eps</a>.</p>
210
211</div>
212</div>
213<h2 class="groupheader">Member Data Documentation</h2>
214<a id="a6089e1ca91914015777ea780a513131a"></a>
215<h2 class="memtitle"><span class="permalink"><a href="#a6089e1ca91914015777ea780a513131a">&#9670;&nbsp;</a></span>m_DataLayout</h2>
216
217<div class="memitem">
218<div class="memproto">
219 <table class="memname">
220 <tr>
221 <td class="memname"><a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0">DataLayout</a> m_DataLayout</td>
222 </tr>
223 </table>
224</div><div class="memdoc">
225
226<p>The data layout to be used (NCHW, NHWC). </p>
227
228<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00843">843</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
229
230<p class="reference">Referenced by <a class="el" href="_batch_norm_impl_8cpp_source.html#l00018">armnn::BatchNormImpl()</a>, <a class="el" href="_descriptors_8hpp_source.html#l00835">BatchNormalizationDescriptor::operator==()</a>, and <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00022">StringifyLayerParameters&lt; BatchNormalizationDescriptor &gt;::Serialize()</a>.</p>
231
232</div>
233</div>
234<a id="a11c821c7524251004a72ed13c510853c"></a>
235<h2 class="memtitle"><span class="permalink"><a href="#a11c821c7524251004a72ed13c510853c">&#9670;&nbsp;</a></span>m_Eps</h2>
236
237<div class="memitem">
238<div class="memproto">
239 <table class="memname">
240 <tr>
241 <td class="memname">float m_Eps</td>
242 </tr>
243 </table>
244</div><div class="memdoc">
245
246<p>Value to add to the variance. Used to avoid dividing by zero. </p>
247
248<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00841">841</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
249
250<p class="reference">Referenced by <a class="el" href="_batch_norm_impl_8cpp_source.html#l00018">armnn::BatchNormImpl()</a>, <a class="el" href="_descriptors_8hpp_source.html#l00835">BatchNormalizationDescriptor::operator==()</a>, <a class="el" href="_fuse_batch_norm_8hpp_source.html#l00027">FuseBatchNorm&lt; ConvLayer, ArmnnType, T &gt;::Run()</a>, and <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00022">StringifyLayerParameters&lt; BatchNormalizationDescriptor &gt;::Serialize()</a>.</p>
251
252</div>
253</div>
254<hr/>The documentation for this struct was generated from the following file:<ul>
255<li>include/armnn/<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a></li>
256</ul>
257</div><!-- contents -->
258</div><!-- doc-content -->
259<div class="ttc" id="astructarmnn_1_1_batch_normalization_descriptor_html_a6089e1ca91914015777ea780a513131a"><div class="ttname"><a href="structarmnn_1_1_batch_normalization_descriptor.html#a6089e1ca91914015777ea780a513131a">armnn::BatchNormalizationDescriptor::m_DataLayout</a></div><div class="ttdeci">DataLayout m_DataLayout</div><div class="ttdoc">The data layout to be used (NCHW, NHWC).</div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00843">Descriptors.hpp:843</a></div></div>
260<div class="ttc" id="astructarmnn_1_1_batch_normalization_descriptor_html_a11c821c7524251004a72ed13c510853c"><div class="ttname"><a href="structarmnn_1_1_batch_normalization_descriptor.html#a11c821c7524251004a72ed13c510853c">armnn::BatchNormalizationDescriptor::m_Eps</a></div><div class="ttdeci">float m_Eps</div><div class="ttdoc">Value to add to the variance. Used to avoid dividing by zero.</div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00841">Descriptors.hpp:841</a></div></div>
261<div class="ttc" id="anamespacearmnn_html_ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f"><div class="ttname"><a href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::DataLayout::NCHW</a></div><div class="ttdeci">@ NCHW</div></div>
262<!-- start footer part -->
263<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
264 <ul>
265 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_batch_normalization_descriptor.html">BatchNormalizationDescriptor</a></li>
266 <li class="footer">Generated on Wed Feb 14 2024 16:36:21 for Arm NN by
267 <a href="http://www.doxygen.org/index.html">
268 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
269 </ul>
270</div>
271</body>
272</html>