documentation/classarm__compute_1_1_c_l_batch_normalization_layer.xhtml

   1 <!-- HTML header for doxygen 1.8.9.1-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.6"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: CLBatchNormalizationLayer Class 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="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <script type="text/x-mathjax-config">
  26   MathJax.Hub.Config({
  27     extensions: ["tex2jax.js"],
  28     jax: ["input/TeX","output/HTML-CSS"],
  29 });
  30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  32 </head>
  33 <body>
  34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  35 <div id="titlearea">
  36 <table cellspacing="0" cellpadding="0">
  37  <tbody>
  38  <tr style="height: 56px;">
  39   <td style="padding-left: 0.5em;">
  40    <div id="projectname">Compute Library
  41    &#160;<span id="projectnumber">17.09</span>
  42    </div>
  43   </td>
  44  </tr>
  45  </tbody>
  46 </table>
  47 </div>
  48 <!-- end header part -->
  49 <!-- Generated by Doxygen 1.8.6 -->
  50 <script type="text/javascript">
  51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  52 </script>
  53   <div id="navrow1" class="tabs">
  54     <ul class="tablist">
  55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  58       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  59       <li><a href="files.xhtml"><span>Files</span></a></li>
  60       <li>
  61         <div id="MSearchBox" class="MSearchBoxInactive">
  62         <span class="left">
  63           <img id="MSearchSelect" src="search/mag_sel.png"
  64                onmouseover="return searchBox.OnSearchSelectShow()"
  65                onmouseout="return searchBox.OnSearchSelectHide()"
  66                alt=""/>
  67           <input type="text" id="MSearchField" value="Search" accesskey="S"
  68                onfocus="searchBox.OnSearchFieldFocus(true)"
  69                onblur="searchBox.OnSearchFieldFocus(false)"
  70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  71           </span><span class="right">
  72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  73           </span>
  74         </div>
  75       </li>
  76     </ul>
  77   </div>
  78   <div id="navrow2" class="tabs2">
  79     <ul class="tablist">
  80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  83       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  84     </ul>
  85   </div>
  86 </div><!-- top -->
  87 <div id="side-nav" class="ui-resizable side-nav-resizable">
  88   <div id="nav-tree">
  89     <div id="nav-tree-contents">
  90       <div id="nav-sync" class="sync"></div>
  91     </div>
  92   </div>
  93   <div id="splitbar" style="-moz-user-select:none;"
  94        class="ui-resizable-handle">
  95   </div>
  96 </div>
  97 <script type="text/javascript">
  98 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_batch_normalization_layer.xhtml','');});
  99 </script>
 100 <div id="doc-content">
 101 <!-- window showing the filter options -->
 102 <div id="MSearchSelectWindow"
 103      onmouseover="return searchBox.OnSearchSelectShow()"
 104      onmouseout="return searchBox.OnSearchSelectHide()"
 105      onkeydown="return searchBox.OnSearchSelectKey(event)">
 106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 107
 108 <!-- iframe showing the search results (closed by default) -->
 109 <div id="MSearchResultsWindow">
 110 <iframe src="javascript:void(0)" frameborder="0"
 111         name="MSearchResults" id="MSearchResults">
 112 </iframe>
 113 </div>
 114
 115 <div class="header">
 116   <div class="summary">
 117 <a href="#pub-methods">Public Member Functions</a>  </div>
 118   <div class="headertitle">
 119 <div class="title">CLBatchNormalizationLayer Class Reference</div>  </div>
 120 </div><!--header-->
 121 <div class="contents">
 122
 123 <p>Basic function to run <a class="el" href="classarm__compute_1_1_c_l_normalization_layer_kernel.xhtml">CLNormalizationLayerKernel</a> and simulate a batch normalization layer.
 124  <a href="classarm__compute_1_1_c_l_batch_normalization_layer.xhtml#details">More...</a></p>
 125
 126 <p><code>#include &lt;<a class="el" href="_c_l_batch_normalization_layer_8h_source.xhtml">CLBatchNormalizationLayer.h</a>&gt;</code></p>
 127 <div class="dynheader">
 128 Collaboration diagram for CLBatchNormalizationLayer:</div>
 129 <div class="dyncontent">
 130 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_batch_normalization_layer__coll__graph.svg" width="196" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 131 </div>
 132 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 133 <table class="memberdecls">
 134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 135 Public Member Functions</h2></td></tr>
 136 <tr class="memitem:aa75c9e345235e7031d6489425e53645a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_batch_normalization_layer.xhtml#aa75c9e345235e7031d6489425e53645a">CLBatchNormalizationLayer</a> ()</td></tr>
 137 <tr class="memdesc:aa75c9e345235e7031d6489425e53645a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#aa75c9e345235e7031d6489425e53645a">More...</a><br/></td></tr>
 138 <tr class="separator:aa75c9e345235e7031d6489425e53645a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:a088b702f0c5f0c0326be2f4b5c2006ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_batch_normalization_layer.xhtml#a088b702f0c5f0c0326be2f4b5c2006ed">configure</a> (<a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *input, <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *output, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *mean, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *var, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *beta, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *gamma, float epsilon)</td></tr>
 140 <tr class="memdesc:a088b702f0c5f0c0326be2f4b5c2006ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the input and output tensors.  <a href="#a088b702f0c5f0c0326be2f4b5c2006ed">More...</a><br/></td></tr>
 141 <tr class="separator:a088b702f0c5f0c0326be2f4b5c2006ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:ad1717410afd0be936c6213a63c8005fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_batch_normalization_layer.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
 143 <tr class="memdesc:ad1717410afd0be936c6213a63c8005fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the kernels contained in the function.  <a href="#ad1717410afd0be936c6213a63c8005fb">More...</a><br/></td></tr>
 144 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_function')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_function.xhtml">IFunction</a></td></tr>
 146 <tr class="memitem:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">~IFunction</a> ()=default</td></tr>
 147 <tr class="memdesc:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">More...</a><br/></td></tr>
 148 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 </table>
 150 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 151 <div class="textblock"><p>Basic function to run <a class="el" href="classarm__compute_1_1_c_l_normalization_layer_kernel.xhtml">CLNormalizationLayerKernel</a> and simulate a batch normalization layer. </p>
 152 <p>Batch normalization is calculated by: </p>
 153 <p class="formulaDsp">
 154 \[ out_i = \gamma * (\frac{in_i - \mu_{B}}{\sqrt{\sigma^2_{B} + \epsilon}}) + \beta \equiv BN_{\gamma,\beta}(in_i) \]
 155 </p>
 156
 157 <p>Definition at line <a class="el" href="_c_l_batch_normalization_layer_8h_source.xhtml#l00042">42</a> of file <a class="el" href="_c_l_batch_normalization_layer_8h_source.xhtml">CLBatchNormalizationLayer.h</a>.</p>
 158 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 159 <a class="anchor" id="aa75c9e345235e7031d6489425e53645a"></a>
 160 <div class="memitem">
 161 <div class="memproto">
 162       <table class="memname">
 163         <tr>
 164           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_batch_normalization_layer.xhtml">CLBatchNormalizationLayer</a> </td>
 165           <td>(</td>
 166           <td class="paramname"></td><td>)</td>
 167           <td></td>
 168         </tr>
 169       </table>
 170 </div><div class="memdoc">
 171
 172 <p>Default constructor. </p>
 173
 174 </div>
 175 </div>
 176 <h2 class="groupheader">Member Function Documentation</h2>
 177 <a class="anchor" id="a088b702f0c5f0c0326be2f4b5c2006ed"></a>
 178 <div class="memitem">
 179 <div class="memproto">
 180       <table class="memname">
 181         <tr>
 182           <td class="memname">void configure </td>
 183           <td>(</td>
 184           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 185           <td class="paramname"><em>input</em>, </td>
 186         </tr>
 187         <tr>
 188           <td class="paramkey"></td>
 189           <td></td>
 190           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 191           <td class="paramname"><em>output</em>, </td>
 192         </tr>
 193         <tr>
 194           <td class="paramkey"></td>
 195           <td></td>
 196           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 197           <td class="paramname"><em>mean</em>, </td>
 198         </tr>
 199         <tr>
 200           <td class="paramkey"></td>
 201           <td></td>
 202           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 203           <td class="paramname"><em>var</em>, </td>
 204         </tr>
 205         <tr>
 206           <td class="paramkey"></td>
 207           <td></td>
 208           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 209           <td class="paramname"><em>beta</em>, </td>
 210         </tr>
 211         <tr>
 212           <td class="paramkey"></td>
 213           <td></td>
 214           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 215           <td class="paramname"><em>gamma</em>, </td>
 216         </tr>
 217         <tr>
 218           <td class="paramkey"></td>
 219           <td></td>
 220           <td class="paramtype">float&#160;</td>
 221           <td class="paramname"><em>epsilon</em>&#160;</td>
 222         </tr>
 223         <tr>
 224           <td></td>
 225           <td>)</td>
 226           <td></td><td></td>
 227         </tr>
 228       </table>
 229 </div><div class="memdoc">
 230
 231 <p>Set the input and output tensors. </p>
 232 <dl class="section note"><dt>Note</dt><dd>If the output tensor is a nullptr, the batch normalization function will be performed in-place</dd></dl>
 233 <dl class="params"><dt>Parameters</dt><dd>
 234   <table class="params">
 235     <tr><td class="paramdir">[in,out]</td><td class="paramname">input</td><td>Source tensor. In case of <code>output</code> tensor = nullptr, this tensor will store the result. 3 lower dimensions represent a single input with dimensions [width, height, FM]. The rest are optional and used for representing batches. Data types supported: QS8/QS16/F16/F32. </td></tr>
 236     <tr><td class="paramdir">[in]</td><td class="paramname">mean</td><td>Mean values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as <code>input</code> </td></tr>
 237     <tr><td class="paramdir">[in]</td><td class="paramname">var</td><td>Variance values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as <code>input</code> </td></tr>
 238     <tr><td class="paramdir">[in]</td><td class="paramname">gamma</td><td>Gamma values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as <code>input</code> </td></tr>
 239     <tr><td class="paramdir">[in]</td><td class="paramname">beta</td><td>Beta values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as <code>input</code> </td></tr>
 240     <tr><td class="paramdir">[in]</td><td class="paramname">epsilon</td><td>Small value to avoid division with zero. </td></tr>
 241     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor. Output will have the same number of dimensions as input. Data type supported: same as <code>input</code> </td></tr>
 242   </table>
 243   </dd>
 244 </dl>
 245
 246 </div>
 247 </div>
 248 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
 249 <div class="memitem">
 250 <div class="memproto">
 251 <table class="mlabels">
 252   <tr>
 253   <td class="mlabels-left">
 254       <table class="memname">
 255         <tr>
 256           <td class="memname">void run </td>
 257           <td>(</td>
 258           <td class="paramname"></td><td>)</td>
 259           <td></td>
 260         </tr>
 261       </table>
 262   </td>
 263   <td class="mlabels-right">
 264 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 265   </tr>
 266 </table>
 267 </div><div class="memdoc">
 268
 269 <p>Run the kernels contained in the function. </p>
 270 <p>For NEON kernels:</p>
 271 <ul>
 272 <li>Multi-threading is used for the kernels which are parallelisable.</li>
 273 <li>By default std::thread::hardware_concurrency() threads are used.</li>
 274 </ul>
 275 <dl class="section note"><dt>Note</dt><dd><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#ae64eebaa07f4d2da6cc2ba538c3cb095">CPPScheduler::set_num_threads()</a> can be used to manually set the number of threads</dd></dl>
 276 <p>For OpenCL kernels:</p>
 277 <ul>
 278 <li>All the kernels are enqueued on the queue associated with <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml" title="Provides global access to a CL context and command queue. ">CLScheduler</a>.</li>
 279 <li>The queue is then flushed.</li>
 280 </ul>
 281 <dl class="section note"><dt>Note</dt><dd>The function will not block until the kernels are executed. It is the user's responsibility to wait. </dd></dl>
 282
 283 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
 284
 285 </div>
 286 </div>
 287 <hr/>The documentation for this class was generated from the following file:<ul>
 288 <li>arm_compute/runtime/CL/functions/<a class="el" href="_c_l_batch_normalization_layer_8h_source.xhtml">CLBatchNormalizationLayer.h</a></li>
 289 </ul>
 290 </div><!-- contents -->
 291 </div><!-- doc-content -->
 292 <!-- start footer part -->
 293 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 294   <ul>
 295     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_c_l_batch_normalization_layer.xhtml">CLBatchNormalizationLayer</a></li>
 296     <li class="footer">Generated on Thu Sep 28 2017 14:37:57 for Compute Library by
 297     <a href="http://www.doxygen.org/index.html">
 298     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 299   </ul>
 300 </div>
 301 </body>
 302 </html>