group__Acti.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  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. <title>Activation Functions</title>
  7. <title>CMSIS-NN: Activation Functions</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.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. <script type="text/javascript" src="printComponentTabs.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. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-NN
  35. &#160;<span id="projectnumber">Version 1.3.0</span>
  36. </div>
  37. <div id="projectbrief">CMSIS NN Software Library</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</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><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('group__Acti.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#func-members">Functions</a> </div>
  110. <div class="headertitle">
  111. <div class="title">Activation Functions<div class="ingroups"><a class="el" href="group__groupNN.html">Neural Network Functions</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  116. Functions</h2></td></tr>
  117. <tr class="memitem:ga8932b57c8d0ee757511af2d40dcc11e7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Acti.html#ga8932b57c8d0ee757511af2d40dcc11e7">arm_nn_activations_direct_q15</a> (q15_t *data, uint16_t size, uint16_t int_width, <a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0">arm_nn_activation_type</a> type)</td></tr>
  118. <tr class="memdesc:ga8932b57c8d0ee757511af2d40dcc11e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">neural network activation function using direct table look-up <a href="#ga8932b57c8d0ee757511af2d40dcc11e7">More...</a><br/></td></tr>
  119. <tr class="separator:ga8932b57c8d0ee757511af2d40dcc11e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ga79f11131ae6767d60e03b1f6506b1af8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Acti.html#ga79f11131ae6767d60e03b1f6506b1af8">arm_nn_activations_direct_q7</a> (q7_t *data, uint16_t size, uint16_t int_width, <a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0">arm_nn_activation_type</a> type)</td></tr>
  121. <tr class="memdesc:ga79f11131ae6767d60e03b1f6506b1af8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 neural network activation function using direct table look-up. <a href="#ga79f11131ae6767d60e03b1f6506b1af8">More...</a><br/></td></tr>
  122. <tr class="separator:ga79f11131ae6767d60e03b1f6506b1af8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ga01a7a7c17f0cd544e29c4752daeecdc3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Acti.html#ga01a7a7c17f0cd544e29c4752daeecdc3">arm_relu6_s8</a> (q7_t *data, uint16_t size)</td></tr>
  124. <tr class="memdesc:ga01a7a7c17f0cd544e29c4752daeecdc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">s8 ReLU6 function <a href="#ga01a7a7c17f0cd544e29c4752daeecdc3">More...</a><br/></td></tr>
  125. <tr class="separator:ga01a7a7c17f0cd544e29c4752daeecdc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:ga53bcc00e54b802919bb3c89c143ee5ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Acti.html#ga53bcc00e54b802919bb3c89c143ee5ba">arm_relu_q15</a> (q15_t *data, uint16_t size)</td></tr>
  127. <tr class="memdesc:ga53bcc00e54b802919bb3c89c143ee5ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q15 RELU function. <a href="#ga53bcc00e54b802919bb3c89c143ee5ba">More...</a><br/></td></tr>
  128. <tr class="separator:ga53bcc00e54b802919bb3c89c143ee5ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ga638e803b4fe00426f401783a6255ca30"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Acti.html#ga638e803b4fe00426f401783a6255ca30">arm_relu_q7</a> (q7_t *data, uint16_t size)</td></tr>
  130. <tr class="memdesc:ga638e803b4fe00426f401783a6255ca30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 RELU function. <a href="#ga638e803b4fe00426f401783a6255ca30">More...</a><br/></td></tr>
  131. <tr class="separator:ga638e803b4fe00426f401783a6255ca30"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. </table>
  133. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  134. <p>Perform activation layers, including ReLU (Rectified Linear Unit), sigmoid and tanh </p>
  135. <h2 class="groupheader">Function Documentation</h2>
  136. <a class="anchor" id="ga8932b57c8d0ee757511af2d40dcc11e7"></a>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">void arm_nn_activations_direct_q15 </td>
  142. <td>(</td>
  143. <td class="paramtype">q15_t *&#160;</td>
  144. <td class="paramname"><em>data</em>, </td>
  145. </tr>
  146. <tr>
  147. <td class="paramkey"></td>
  148. <td></td>
  149. <td class="paramtype">uint16_t&#160;</td>
  150. <td class="paramname"><em>size</em>, </td>
  151. </tr>
  152. <tr>
  153. <td class="paramkey"></td>
  154. <td></td>
  155. <td class="paramtype">uint16_t&#160;</td>
  156. <td class="paramname"><em>int_width</em>, </td>
  157. </tr>
  158. <tr>
  159. <td class="paramkey"></td>
  160. <td></td>
  161. <td class="paramtype"><a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0">arm_nn_activation_type</a>&#160;</td>
  162. <td class="paramname"><em>type</em>&#160;</td>
  163. </tr>
  164. <tr>
  165. <td></td>
  166. <td>)</td>
  167. <td></td><td></td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <p>Q15 neural network activation function using direct table look-up.</p>
  172. <dl class="section note"><dt>Note</dt><dd>Refer header file for details. </dd></dl>
  173. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0a49b307e029715fbaa6f3101c806b8c54">ARM_SIGMOID</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0ac24e4db95c986f16c10dca71a4b4e1c5">ARM_TANH</a>, <a class="el" href="arm__nn__tables_8h.html#ab4d7b07c387a3537d4efe21da86115b0">sigmoidTable_q15</a>, and <a class="el" href="arm__nn__tables_8h.html#a6faad2fec173b2702fd0f219a83ca320">tanhTable_q15</a>.</p>
  174. <p>Referenced by <a class="el" href="arm__nnexamples__gru_8cpp.html#ac71a806472c7c0c284a2253e71a6a27b">gru_example()</a>.</p>
  175. </div>
  176. </div>
  177. <a class="anchor" id="ga79f11131ae6767d60e03b1f6506b1af8"></a>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="memname">
  181. <tr>
  182. <td class="memname">void arm_nn_activations_direct_q7 </td>
  183. <td>(</td>
  184. <td class="paramtype">q7_t *&#160;</td>
  185. <td class="paramname"><em>data</em>, </td>
  186. </tr>
  187. <tr>
  188. <td class="paramkey"></td>
  189. <td></td>
  190. <td class="paramtype">uint16_t&#160;</td>
  191. <td class="paramname"><em>size</em>, </td>
  192. </tr>
  193. <tr>
  194. <td class="paramkey"></td>
  195. <td></td>
  196. <td class="paramtype">uint16_t&#160;</td>
  197. <td class="paramname"><em>int_width</em>, </td>
  198. </tr>
  199. <tr>
  200. <td class="paramkey"></td>
  201. <td></td>
  202. <td class="paramtype"><a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0">arm_nn_activation_type</a>&#160;</td>
  203. <td class="paramname"><em>type</em>&#160;</td>
  204. </tr>
  205. <tr>
  206. <td></td>
  207. <td>)</td>
  208. <td></td><td></td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. <dl class="params"><dt>Parameters</dt><dd>
  213. <table class="params">
  214. <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>pointer to input </td></tr>
  215. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>number of elements </td></tr>
  216. <tr><td class="paramdir">[in]</td><td class="paramname">int_width</td><td>bit-width of the integer part, assume to be smaller than 3 </td></tr>
  217. <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>type of activation functions</td></tr>
  218. </table>
  219. </dd>
  220. </dl>
  221. <p>This is the direct table look-up approach.</p>
  222. <p>Assume here the integer part of the fixed-point is &lt;= 3. More than 3 just not making much sense, makes no difference with saturation followed by any of these activation functions. </p>
  223. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0a49b307e029715fbaa6f3101c806b8c54">ARM_SIGMOID</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0ac24e4db95c986f16c10dca71a4b4e1c5">ARM_TANH</a>, <a class="el" href="arm__nn__tables_8h.html#ae2ff3f4e7014f535358167150bdd544f">sigmoidTable_q7</a>, and <a class="el" href="arm__nn__tables_8h.html#a4f854bdf13f630ec21b3ad074491e32f">tanhTable_q7</a>.</p>
  224. </div>
  225. </div>
  226. <a class="anchor" id="ga01a7a7c17f0cd544e29c4752daeecdc3"></a>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">void arm_relu6_s8 </td>
  232. <td>(</td>
  233. <td class="paramtype">q7_t *&#160;</td>
  234. <td class="paramname"><em>data</em>, </td>
  235. </tr>
  236. <tr>
  237. <td class="paramkey"></td>
  238. <td></td>
  239. <td class="paramtype">uint16_t&#160;</td>
  240. <td class="paramname"><em>size</em>&#160;</td>
  241. </tr>
  242. <tr>
  243. <td></td>
  244. <td>)</td>
  245. <td></td><td></td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <dl class="params"><dt>Parameters</dt><dd>
  250. <table class="params">
  251. <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>pointer to input </td></tr>
  252. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>number of elements </td></tr>
  253. </table>
  254. </dd>
  255. </dl>
  256. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#adcd021ac91d43a62b2cdecf9a5b971a7">MIN</a>.</p>
  257. </div>
  258. </div>
  259. <a class="anchor" id="ga53bcc00e54b802919bb3c89c143ee5ba"></a>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname">void arm_relu_q15 </td>
  265. <td>(</td>
  266. <td class="paramtype">q15_t *&#160;</td>
  267. <td class="paramname"><em>data</em>, </td>
  268. </tr>
  269. <tr>
  270. <td class="paramkey"></td>
  271. <td></td>
  272. <td class="paramtype">uint16_t&#160;</td>
  273. <td class="paramname"><em>size</em>&#160;</td>
  274. </tr>
  275. <tr>
  276. <td></td>
  277. <td>)</td>
  278. <td></td><td></td>
  279. </tr>
  280. </table>
  281. </div><div class="memdoc">
  282. <dl class="params"><dt>Parameters</dt><dd>
  283. <table class="params">
  284. <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>pointer to input </td></tr>
  285. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>number of elements</td></tr>
  286. </table>
  287. </dd>
  288. </dl>
  289. <p>Optimized relu with QSUB instructions. </p>
  290. </div>
  291. </div>
  292. <a class="anchor" id="ga638e803b4fe00426f401783a6255ca30"></a>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">void arm_relu_q7 </td>
  298. <td>(</td>
  299. <td class="paramtype">q7_t *&#160;</td>
  300. <td class="paramname"><em>data</em>, </td>
  301. </tr>
  302. <tr>
  303. <td class="paramkey"></td>
  304. <td></td>
  305. <td class="paramtype">uint16_t&#160;</td>
  306. <td class="paramname"><em>size</em>&#160;</td>
  307. </tr>
  308. <tr>
  309. <td></td>
  310. <td>)</td>
  311. <td></td><td></td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. <dl class="params"><dt>Parameters</dt><dd>
  316. <table class="params">
  317. <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>pointer to input </td></tr>
  318. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>number of elements</td></tr>
  319. </table>
  320. </dd>
  321. </dl>
  322. <p>Optimized relu with QSUB instructions. </p>
  323. <p>Referenced by <a class="el" href="arm__nnexamples__cifar10_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>
  324. </div>
  325. </div>
  326. </div><!-- contents -->
  327. </div><!-- doc-content -->
  328. <!-- start footer part -->
  329. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  330. <ul>
  331. <li class="footer">Generated on Thu Apr 9 2020 15:49:34 for CMSIS-NN Version 1.3.0 by Arm Ltd. All rights reserved.
  332. <!--
  333. <a href="http://www.doxygen.org/index.html">
  334. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  335. -->
  336. </li>
  337. </ul>
  338. </div>
  339. </body>
  340. </html>