Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 78229c4e6472b6e30627d549c97e9cbe678ec4d3 / . / Documentation / structarmnn_1_1_batch_normalization_descriptor.html
blob: cfd70b300722c4f685a66e225d041223c3117b1b [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>ArmNN: BatchNormalizationDescriptor Struct Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<link href="doxygen.css" rel="stylesheet" type="text/css" />
23</head>
24<body>
25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26<div id="titlearea">
27<table cellspacing="0" cellpadding="0">
28 <tbody>
29 <tr style="height: 56px;">
30 <td id="projectalign" style="padding-left: 0.5em;">
31 <div id="projectname">ArmNN
32 &#160;<span id="projectnumber">NotReleased</span>
33 </div>
34 </td>
35 </tr>
36 </tbody>
37</table>
38</div>
39<!-- end header part -->
40<!-- Generated by Doxygen 1.8.13 -->
41<script type="text/javascript">
42var searchBox = new SearchBox("searchBox", "search",false,'Search');
43</script>
44<script type="text/javascript" src="menudata.js"></script>
45<script type="text/javascript" src="menu.js"></script>
46<script type="text/javascript">
47$(function() {
48 initMenu('',true,false,'search.php','Search');
49 $(document).ready(function() { init_search(); });
50});
51</script>
52<div id="main-nav"></div>
53</div><!-- top -->
54<div id="side-nav" class="ui-resizable side-nav-resizable">
55 <div id="nav-tree">
56 <div id="nav-tree-contents">
57 <div id="nav-sync" class="sync"></div>
58 </div>
59 </div>
60 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle">
62 </div>
63</div>
64<script type="text/javascript">
65$(document).ready(function(){initNavTree('structarmnn_1_1_batch_normalization_descriptor.html','');});
66</script>
67<div id="doc-content">
68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73</div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
80</div>
81
82<div class="header">
83 <div class="summary">
84<a href="#pub-methods">Public Member Functions</a> &#124;
85<a href="#pub-attribs">Public Attributes</a> &#124;
86<a href="structarmnn_1_1_batch_normalization_descriptor-members.html">List of all members</a> </div>
87 <div class="headertitle">
88<div class="title">BatchNormalizationDescriptor Struct Reference</div> </div>
89</div><!--header-->
90<div class="contents">
91
92<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>.
93 <a href="structarmnn_1_1_batch_normalization_descriptor.html#details">More...</a></p>
94
95<p><code>#include &lt;<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>&gt;</code></p>
96<table class="memberdecls">
97<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
98Public Member Functions</h2></td></tr>
99<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>
100<tr class="separator:aefba12eed94174fb6eaeb78b6eaf7e59"><td class="memSeparator" colspan="2">&#160;</td></tr>
101<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>
102<tr class="separator:a65f4f175144b079a9b33eb4871192af6"><td class="memSeparator" colspan="2">&#160;</td></tr>
103</table><table class="memberdecls">
104<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
105Public Attributes</h2></td></tr>
106<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>
107<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="#a11c821c7524251004a72ed13c510853c">More...</a><br /></td></tr>
108<tr class="separator:a11c821c7524251004a72ed13c510853c"><td class="memSeparator" colspan="2">&#160;</td></tr>
109<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>
110<tr class="memdesc:a6089e1ca91914015777ea780a513131a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The data layout to be used (NCHW, NHWC). <a href="#a6089e1ca91914015777ea780a513131a">More...</a><br /></td></tr>
111<tr class="separator:a6089e1ca91914015777ea780a513131a"><td class="memSeparator" colspan="2">&#160;</td></tr>
112</table>
113<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
114<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>
115
116<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00610">610</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
117</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
118<a id="aefba12eed94174fb6eaeb78b6eaf7e59"></a>
119<h2 class="memtitle"><span class="permalink"><a href="#aefba12eed94174fb6eaeb78b6eaf7e59">&#9670;&nbsp;</a></span>BatchNormalizationDescriptor()</h2>
120
121<div class="memitem">
122<div class="memproto">
123<table class="mlabels">
124 <tr>
125 <td class="mlabels-left">
126 <table class="memname">
127 <tr>
128 <td class="memname"><a class="el" href="structarmnn_1_1_batch_normalization_descriptor.html">BatchNormalizationDescriptor</a> </td>
129 <td>(</td>
130 <td class="paramname"></td><td>)</td>
131 <td></td>
132 </tr>
133 </table>
134 </td>
135 <td class="mlabels-right">
136<span class="mlabels"><span class="mlabel">inline</span></span> </td>
137 </tr>
138</table>
139</div><div class="memdoc">
140
141<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00612">612</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
142<div class="fragment"><div class="line"><a name="l00613"></a><span class="lineno"> 613</span>&#160; : <a class="code" href="structarmnn_1_1_batch_normalization_descriptor.html#a11c821c7524251004a72ed13c510853c">m_Eps</a>(0.0001f)</div><div class="line"><a name="l00614"></a><span class="lineno"> 614</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><div class="line"><a name="l00615"></a><span class="lineno"> 615</span>&#160; {}</div><div class="ttc" id="namespacearmnn_html_ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f"><div class="ttname"><a href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::DataLayout::NCHW</a></div></div>
143<div class="ttc" id="structarmnn_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#l00623">Descriptors.hpp:623</a></div></div>
144<div class="ttc" id="structarmnn_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#l00625">Descriptors.hpp:625</a></div></div>
145</div><!-- fragment -->
146</div>
147</div>
148<h2 class="groupheader">Member Function Documentation</h2>
149<a id="a65f4f175144b079a9b33eb4871192af6"></a>
150<h2 class="memtitle"><span class="permalink"><a href="#a65f4f175144b079a9b33eb4871192af6">&#9670;&nbsp;</a></span>operator==()</h2>
151
152<div class="memitem">
153<div class="memproto">
154<table class="mlabels">
155 <tr>
156 <td class="mlabels-left">
157 <table class="memname">
158 <tr>
159 <td class="memname">bool operator== </td>
160 <td>(</td>
161 <td class="paramtype">const <a class="el" href="structarmnn_1_1_batch_normalization_descriptor.html">BatchNormalizationDescriptor</a> &amp;&#160;</td>
162 <td class="paramname"><em>rhs</em></td><td>)</td>
163 <td> const</td>
164 </tr>
165 </table>
166 </td>
167 <td class="mlabels-right">
168<span class="mlabels"><span class="mlabel">inline</span></span> </td>
169 </tr>
170</table>
171</div><div class="memdoc">
172
173<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00617">617</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
174
175<p class="reference">References <a class="el" href="_descriptors_8hpp_source.html#l00625">BatchNormalizationDescriptor::m_DataLayout</a>, and <a class="el" href="_descriptors_8hpp_source.html#l00623">BatchNormalizationDescriptor::m_Eps</a>.</p>
176<div class="fragment"><div class="line"><a name="l00618"></a><span class="lineno"> 618</span>&#160; {</div><div class="line"><a name="l00619"></a><span class="lineno"> 619</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><div class="line"><a name="l00620"></a><span class="lineno"> 620</span>&#160; }</div><div class="ttc" id="structarmnn_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#l00623">Descriptors.hpp:623</a></div></div>
177<div class="ttc" id="structarmnn_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#l00625">Descriptors.hpp:625</a></div></div>
178</div><!-- fragment -->
179</div>
180</div>
181<h2 class="groupheader">Member Data Documentation</h2>
182<a id="a6089e1ca91914015777ea780a513131a"></a>
183<h2 class="memtitle"><span class="permalink"><a href="#a6089e1ca91914015777ea780a513131a">&#9670;&nbsp;</a></span>m_DataLayout</h2>
184
185<div class="memitem">
186<div class="memproto">
187 <table class="memname">
188 <tr>
189 <td class="memname"><a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0">DataLayout</a> m_DataLayout</td>
190 </tr>
191 </table>
192</div><div class="memdoc">
193
194<p>The data layout to be used (NCHW, NHWC). </p>
195
196<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00625">625</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
197
198<p class="reference">Referenced by <a class="el" href="_batch_norm_impl_8cpp_source.html#l00018">armnn::BatchNormImpl()</a>, <a class="el" href="_const_tensor_layer_visitor_8cpp_source.html#l00467">armnn::BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_const_tensor_layer_visitor_8cpp_source.html#l00045">TestBatchNormalizationLayerVisitor::CheckDescriptor()</a>, <a class="el" href="_deserializer_8cpp_source.html#l00753">Deserializer::GetNetworkOutputBindingInfo()</a>, <a class="el" href="_descriptors_8hpp_source.html#l00617">BatchNormalizationDescriptor::operator==()</a>, <a class="el" href="_tf_parser_8cpp_source.html#l01466">armnnTfParser::OutputShapeOfExpandDims()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00076">StringifyLayerParameters&lt; BatchNormalizationDescriptor &gt;::Serialize()</a>, and <a class="el" href="_serializer_8cpp_source.html#l00228">SerializerVisitor::VisitBatchNormalizationLayer()</a>.</p>
199
200</div>
201</div>
202<a id="a11c821c7524251004a72ed13c510853c"></a>
203<h2 class="memtitle"><span class="permalink"><a href="#a11c821c7524251004a72ed13c510853c">&#9670;&nbsp;</a></span>m_Eps</h2>
204
205<div class="memitem">
206<div class="memproto">
207 <table class="memname">
208 <tr>
209 <td class="memname">float m_Eps</td>
210 </tr>
211 </table>
212</div><div class="memdoc">
213
214<p>Value to add to the variance. Used to avoid dividing by zero. </p>
215
216<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00623">623</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
217
218<p class="reference">Referenced by <a class="el" href="_batch_norm_impl_8cpp_source.html#l00018">armnn::BatchNormImpl()</a>, <a class="el" href="_serializer_tests_8cpp_source.html#l00329">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_const_tensor_layer_visitor_8cpp_source.html#l00467">armnn::BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_const_tensor_layer_visitor_8cpp_source.html#l00045">TestBatchNormalizationLayerVisitor::CheckDescriptor()</a>, <a class="el" href="_batch_normalization_test_impl_8cpp_source.html#l00587">CompareBatchNormTest()</a>, <a class="el" href="_onnx_parser_8cpp_source.html#l00584">OnnxParser::CreateNetworkFromString()</a>, <a class="el" href="_deserializer_8cpp_source.html#l00753">Deserializer::GetNetworkOutputBindingInfo()</a>, <a class="el" href="_descriptors_8hpp_source.html#l00617">BatchNormalizationDescriptor::operator==()</a>, <a class="el" href="_tf_parser_8cpp_source.html#l01466">armnnTfParser::OutputShapeOfExpandDims()</a>, <a class="el" href="_caffe_parser_8cpp_source.html#l01338">CaffeParserBase::ParseBatchNormLayer()</a>, <a class="el" href="_caffe_parser_8cpp_source.html#l01404">CaffeParserBase::ParseScaleLayer()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00076">StringifyLayerParameters&lt; BatchNormalizationDescriptor &gt;::Serialize()</a>, and <a class="el" href="_serializer_8cpp_source.html#l00228">SerializerVisitor::VisitBatchNormalizationLayer()</a>.</p>
219
220</div>
221</div>
222<hr/>The documentation for this struct was generated from the following file:<ul>
223<li>include/armnn/<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a></li>
224</ul>
225</div><!-- contents -->
226</div><!-- doc-content -->
227<!-- start footer part -->
228<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
229 <ul>
230 <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>
231 <li class="footer">Generated on Fri Mar 13 2020 16:07:02 for ArmNN by
232 <a href="http://www.doxygen.org/index.html">
233 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
234 </ul>
235</div>
236</body>
237</html>