documentation/classarm__compute_1_1_c_l_softmax_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.11"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: CLSoftmaxLayer 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="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <script type="text/javascript">
  18   $(document).ready(initResizable);
  19   $(window).load(resizeHeight);
  20 </script>
  21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22 <script type="text/javascript" src="search/searchdata.js"></script>
  23 <script type="text/javascript" src="search/search.js"></script>
  24 <script type="text/javascript">
  25   $(document).ready(function() { init_search(); });
  26 </script>
  27 <script type="text/x-mathjax-config">
  28   MathJax.Hub.Config({
  29     extensions: ["tex2jax.js"],
  30     jax: ["input/TeX","output/HTML-CSS"],
  31 });
  32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 56px;">
  41   <td style="padding-left: 0.5em;">
  42    <div id="projectname">Compute Library
  43    &#160;<span id="projectnumber">18.02</span>
  44    </div>
  45   </td>
  46  </tr>
  47  </tbody>
  48 </table>
  49 </div>
  50 <!-- end header part -->
  51 <!-- Generated by Doxygen 1.8.11 -->
  52 <script type="text/javascript">
  53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  54 </script>
  55   <div id="navrow1" class="tabs">
  56     <ul class="tablist">
  57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  61       <li><a href="files.xhtml"><span>Files</span></a></li>
  62       <li>
  63         <div id="MSearchBox" class="MSearchBoxInactive">
  64         <span class="left">
  65           <img id="MSearchSelect" src="search/mag_sel.png"
  66                onmouseover="return searchBox.OnSearchSelectShow()"
  67                onmouseout="return searchBox.OnSearchSelectHide()"
  68                alt=""/>
  69           <input type="text" id="MSearchField" value="Search" accesskey="S"
  70                onfocus="searchBox.OnSearchFieldFocus(true)"
  71                onblur="searchBox.OnSearchFieldFocus(false)"
  72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73           </span><span class="right">
  74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75           </span>
  76         </div>
  77       </li>
  78     </ul>
  79   </div>
  80   <div id="navrow2" class="tabs2">
  81     <ul class="tablist">
  82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  86     </ul>
  87   </div>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_softmax_layer.xhtml','');});
 101 </script>
 102 <div id="doc-content">
 103 <!-- window showing the filter options -->
 104 <div id="MSearchSelectWindow"
 105      onmouseover="return searchBox.OnSearchSelectShow()"
 106      onmouseout="return searchBox.OnSearchSelectHide()"
 107      onkeydown="return searchBox.OnSearchSelectKey(event)">
 108 </div>
 109
 110 <!-- iframe showing the search results (closed by default) -->
 111 <div id="MSearchResultsWindow">
 112 <iframe src="javascript:void(0)" frameborder="0"
 113         name="MSearchResults" id="MSearchResults">
 114 </iframe>
 115 </div>
 116
 117 <div class="header">
 118   <div class="summary">
 119 <a href="#pub-methods">Public Member Functions</a> &#124;
 120 <a href="#pub-static-methods">Static Public Member Functions</a>  </div>
 121   <div class="headertitle">
 122 <div class="title">CLSoftmaxLayer Class Reference</div>  </div>
 123 </div><!--header-->
 124 <div class="contents">
 125
 126 <p>Basic function to compute a SoftmaxLayer.
 127  <a href="classarm__compute_1_1_c_l_softmax_layer.xhtml#details">More...</a></p>
 128
 129 <p><code>#include &lt;<a class="el" href="_c_l_softmax_layer_8h_source.xhtml">CLSoftmaxLayer.h</a>&gt;</code></p>
 130 <div class="dynheader">
 131 Collaboration diagram for CLSoftmaxLayer:</div>
 132 <div class="dyncontent">
 133 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_softmax_layer__coll__graph.svg" width="138" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 134 </div>
 135 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 136 <table class="memberdecls">
 137 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 138 Public Member Functions</h2></td></tr>
 139 <tr class="memitem:a6ff0e7d2274ef82a3418820ca8b00302"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_softmax_layer.xhtml#a6ff0e7d2274ef82a3418820ca8b00302">CLSoftmaxLayer</a> (std::shared_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> &gt; memory_manager=nullptr)</td></tr>
 140 <tr class="memdesc:a6ff0e7d2274ef82a3418820ca8b00302"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a6ff0e7d2274ef82a3418820ca8b00302">More...</a><br /></td></tr>
 141 <tr class="separator:a6ff0e7d2274ef82a3418820ca8b00302"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:a77a4f0c2598309656799d2023ca2e9d8"><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_softmax_layer.xhtml#a77a4f0c2598309656799d2023ca2e9d8">configure</a> (const <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, float beta=1.0f)</td></tr>
 143 <tr class="memdesc:a77a4f0c2598309656799d2023ca2e9d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the input and output tensors.  <a href="#a77a4f0c2598309656799d2023ca2e9d8">More...</a><br /></td></tr>
 144 <tr class="separator:a77a4f0c2598309656799d2023ca2e9d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <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_softmax_layer.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
 146 <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>
 147 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <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>
 149 <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>
 150 <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>
 151 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 </table><table class="memberdecls">
 153 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
 154 Static Public Member Functions</h2></td></tr>
 155 <tr class="memitem:a5192c53832168a12f3997ea01101aa06"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_softmax_layer.xhtml#a5192c53832168a12f3997ea01101aa06">validate</a> (const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *input, const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *output)</td></tr>
 156 <tr class="memdesc:a5192c53832168a12f3997ea01101aa06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_c_l_softmax_layer.xhtml">CLSoftmaxLayer</a>.  <a href="#a5192c53832168a12f3997ea01101aa06">More...</a><br /></td></tr>
 157 <tr class="separator:a5192c53832168a12f3997ea01101aa06"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 </table>
 159 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 160 <div class="textblock"><p>Basic function to compute a SoftmaxLayer. </p>
 161 <p>Softmax is calculated by : </p><p class="formulaDsp">
 162 \[ out = exp((x - max(x)) * beta) / sum(exp((x - max(x)) * beta)) \]
 163 </p>
 164 <p>This function runs the following kernels:</p><ol type="1">
 165 <li><a class="el" href="classarm__compute_1_1_c_l_logits1_d_max_kernel.xhtml">CLLogits1DMaxKernel</a></li>
 166 <li><a class="el" href="classarm__compute_1_1_c_l_logits1_d_shift_exp_sum_kernel.xhtml">CLLogits1DShiftExpSumKernel</a></li>
 167 <li><a class="el" href="classarm__compute_1_1_c_l_logits1_d_norm_kernel.xhtml">CLLogits1DNormKernel</a> </li>
 168 </ol>
 169
 170 <p>Definition at line <a class="el" href="_c_l_softmax_layer_8h_source.xhtml#l00049">49</a> of file <a class="el" href="_c_l_softmax_layer_8h_source.xhtml">CLSoftmaxLayer.h</a>.</p>
 171 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 172 <a class="anchor" id="a6ff0e7d2274ef82a3418820ca8b00302"></a>
 173 <div class="memitem">
 174 <div class="memproto">
 175       <table class="memname">
 176         <tr>
 177           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_softmax_layer.xhtml">CLSoftmaxLayer</a> </td>
 178           <td>(</td>
 179           <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> &gt;&#160;</td>
 180           <td class="paramname"><em>memory_manager</em> = <code>nullptr</code></td><td>)</td>
 181           <td></td>
 182         </tr>
 183       </table>
 184 </div><div class="memdoc">
 185
 186 <p>Constructor. </p>
 187
 188 </div>
 189 </div>
 190 <h2 class="groupheader">Member Function Documentation</h2>
 191 <a class="anchor" id="a77a4f0c2598309656799d2023ca2e9d8"></a>
 192 <div class="memitem">
 193 <div class="memproto">
 194       <table class="memname">
 195         <tr>
 196           <td class="memname">void configure </td>
 197           <td>(</td>
 198           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 199           <td class="paramname"><em>input</em>, </td>
 200         </tr>
 201         <tr>
 202           <td class="paramkey"></td>
 203           <td></td>
 204           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 205           <td class="paramname"><em>output</em>, </td>
 206         </tr>
 207         <tr>
 208           <td class="paramkey"></td>
 209           <td></td>
 210           <td class="paramtype">float&#160;</td>
 211           <td class="paramname"><em>beta</em> = <code>1.0f</code>&#160;</td>
 212         </tr>
 213         <tr>
 214           <td></td>
 215           <td>)</td>
 216           <td></td><td></td>
 217         </tr>
 218       </table>
 219 </div><div class="memdoc">
 220
 221 <p>Set the input and output tensors. </p>
 222 <dl class="params"><dt>Parameters</dt><dd>
 223   <table class="params">
 224     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data types supported: QS8/QASYMM8/QS16/F16/F32 </td></tr>
 225     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor. Data types supported: same as <code>input</code> </td></tr>
 226     <tr><td class="paramdir">[in]</td><td class="paramname">beta</td><td>(Optional) A scaling factor for the exponent. Defaults to 1.f </td></tr>
 227   </table>
 228   </dd>
 229 </dl>
 230
 231 <p>Referenced by <a class="el" href="validation_2_c_l_2_softmax_layer_8cpp_source.xhtml#l00070">arm_compute::test::validation::DATA_TEST_CASE()</a>.</p>
 232
 233 </div>
 234 </div>
 235 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
 236 <div class="memitem">
 237 <div class="memproto">
 238 <table class="mlabels">
 239   <tr>
 240   <td class="mlabels-left">
 241       <table class="memname">
 242         <tr>
 243           <td class="memname">void run </td>
 244           <td>(</td>
 245           <td class="paramname"></td><td>)</td>
 246           <td></td>
 247         </tr>
 248       </table>
 249   </td>
 250   <td class="mlabels-right">
 251 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 252   </tr>
 253 </table>
 254 </div><div class="memdoc">
 255
 256 <p>Run the kernels contained in the function. </p>
 257 <p>For NEON kernels:</p><ul>
 258 <li>Multi-threading is used for the kernels which are parallelisable.</li>
 259 <li>By default std::thread::hardware_concurrency() threads are used.</li>
 260 </ul>
 261 <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>
 262 <p>For OpenCL kernels:</p><ul>
 263 <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>
 264 <li>The queue is then flushed.</li>
 265 </ul>
 266 <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>
 267
 268 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
 269
 270 </div>
 271 </div>
 272 <a class="anchor" id="a5192c53832168a12f3997ea01101aa06"></a>
 273 <div class="memitem">
 274 <div class="memproto">
 275 <table class="mlabels">
 276   <tr>
 277   <td class="mlabels-left">
 278       <table class="memname">
 279         <tr>
 280           <td class="memname">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a> validate </td>
 281           <td>(</td>
 282           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
 283           <td class="paramname"><em>input</em>, </td>
 284         </tr>
 285         <tr>
 286           <td class="paramkey"></td>
 287           <td></td>
 288           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
 289           <td class="paramname"><em>output</em>&#160;</td>
 290         </tr>
 291         <tr>
 292           <td></td>
 293           <td>)</td>
 294           <td></td><td></td>
 295         </tr>
 296       </table>
 297   </td>
 298   <td class="mlabels-right">
 299 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 300   </tr>
 301 </table>
 302 </div><div class="memdoc">
 303
 304 <p>Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_c_l_softmax_layer.xhtml">CLSoftmaxLayer</a>. </p>
 305 <dl class="params"><dt>Parameters</dt><dd>
 306   <table class="params">
 307     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data types supported: QS8/QASYMM8/QS16/F16/F32 </td></tr>
 308     <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>Destination tensor. Data types supported: same as <code>input</code> </td></tr>
 309   </table>
 310   </dd>
 311 </dl>
 312 <dl class="section return"><dt>Returns</dt><dd>a status </dd></dl>
 313
 314 <p>Referenced by <a class="el" href="validation_2_c_l_2_softmax_layer_8cpp_source.xhtml#l00106">arm_compute::test::validation::DATA_TEST_CASE()</a>.</p>
 315
 316 </div>
 317 </div>
 318 <hr/>The documentation for this class was generated from the following file:<ul>
 319 <li>arm_compute/runtime/CL/functions/<a class="el" href="_c_l_softmax_layer_8h_source.xhtml">CLSoftmaxLayer.h</a></li>
 320 </ul>
 321 </div><!-- contents -->
 322 </div><!-- doc-content -->
 323 <!-- start footer part -->
 324 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 325   <ul>
 326     <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_softmax_layer.xhtml">CLSoftmaxLayer</a></li>
 327     <li class="footer">Generated on Thu Feb 22 2018 15:45:24 for Compute Library by
 328     <a href="http://www.doxygen.org/index.html">
 329     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 330   </ul>
 331 </div>
 332 </body>
 333 </html>