Главная Обзор Помощь
Вход
ARM-software
/
CMSIS_5
зеркало из https://github-proxy.rt-thread.io/ARM-software/CMSIS_5.git
2
0
Ответвить 0
Файлы Задачи 0 Вики
Дерево: c5ff98f525
Ветки Метки
CMSIS_5
/
docs
/
NN
/
html
/
group__Softmax.html

group__Softmax.html 26 KB
История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>Softmax Functions</title>
    7. 

  7. <title>CMSIS-NN: Softmax Functions</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <script type="text/javascript" src="printComponentTabs.js"></script>
    13. 

  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    14. 

  14. <script type="text/javascript" src="resize.js"></script>
    15. 

  15. <script type="text/javascript" src="navtree.js"></script>
    16. 

  16. <script type="text/javascript">
    17. 

  17.   $(document).ready(initResizable);
    18. 

  18.   $(window).load(resizeHeight);
    19. 

  19. </script>
    20. 

  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    21. 

  21. <script type="text/javascript" src="search/search.js"></script>
    22. 

  22. <script type="text/javascript">
    23. 

  23.   $(document).ready(function() { searchBox.OnSelectItem(0); });
    24. 

  24. </script>
    25. 

  25. </head>
    26. 

  26. <body>
    27. 

  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    28. 

  28. <div id="titlearea">
    29. 

  29. <table cellspacing="0" cellpadding="0">
    30. 

  30.  <tbody>
    31. 

  31.  <tr style="height: 46px;">
    32. 

  32.   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
    33. 

  33.   <td style="padding-left: 0.5em;">
    34. 

  34.    <div id="projectname">CMSIS-NN
    35. 

  35.    &#160;<span id="projectnumber">Version 1.3.0</span>
    36. 

  36.    </div>
    37. 

  37.    <div id="projectbrief">CMSIS NN Software Library</div>
    38. 

  38.   </td>
    39. 

  39.  </tr>
    40. 

  40.  </tbody>
    41. 

  41. </table>
    42. 

  42. </div>
    43. 

  43. <!-- end header part -->
    44. 

  44. <div id="CMSISnav" class="tabs1">
    45. 

  45.     <ul class="tablist">
    46. 

  46.       <script type="text/javascript">
    47. 

  47. 		<!--
    48. 

  48. 		writeComponentTabs.call(this);
    49. 

  49. 		//-->
    50. 

  50.       </script>
    51. 

  51. 	  </ul>
    52. 

  52. </div>
    53. 

  53. <!-- Generated by Doxygen 1.8.6 -->
    54. 

  54. <script type="text/javascript">
    55. 

  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    56. 

  56. </script>
    57. 

  57.   <div id="navrow1" class="tabs">
    58. 

  58.     <ul class="tablist">
    59. 

  59.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    60. 

  60.       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
    61. 

  61.       <li><a href="modules.html"><span>Reference</span></a></li>
    62. 

  62.       <li>
    63. 

  63.         <div id="MSearchBox" class="MSearchBoxInactive">
    64. 

  64.         <span class="left">
    65. 

  65.           <img id="MSearchSelect" src="search/mag_sel.png"
    66. 

  66.                onmouseover="return searchBox.OnSearchSelectShow()"
    67. 

  67.                onmouseout="return searchBox.OnSearchSelectHide()"
    68. 

  68.                alt=""/>
    69. 

  69.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    70. 

  70.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    71. 

  71.                onblur="searchBox.OnSearchFieldFocus(false)" 
    72. 

  72.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    73. 

  73.           </span><span class="right">
    74. 

  74.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    75. 

  75.           </span>
    76. 

  76.         </div>
    77. 

  77.       </li>
    78. 

  78.     </ul>
    79. 

  79.   </div>
    80. 

  80. </div><!-- top -->
    81. 

  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
    82. 

  82.   <div id="nav-tree">
    83. 

  83.     <div id="nav-tree-contents">
    84. 

  84.       <div id="nav-sync" class="sync"></div>
    85. 

  85.     </div>
    86. 

  86.   </div>
    87. 

  87.   <div id="splitbar" style="-moz-user-select:none;" 
    88. 

  88.        class="ui-resizable-handle">
    89. 

  89.   </div>
    90. 

  90. </div>
    91. 

  91. <script type="text/javascript">
    92. 

  92. $(document).ready(function(){initNavTree('group__Softmax.html','');});
    93. 

  93. </script>
    94. 

  94. <div id="doc-content">
    95. 

  95. <!-- window showing the filter options -->
    96. 

  96. <div id="MSearchSelectWindow"
    97. 

  97.      onmouseover="return searchBox.OnSearchSelectShow()"
    98. 

  98.      onmouseout="return searchBox.OnSearchSelectHide()"
    99. 

  99.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    100. 

  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. 

  101. 

  102. <!-- iframe showing the search results (closed by default) -->
    103. 

  103. <div id="MSearchResultsWindow">
    104. 

  104. <iframe src="javascript:void(0)" frameborder="0" 
    105. 

  105.         name="MSearchResults" id="MSearchResults">
    106. 

  106. </iframe>
    107. 

  107. </div>
    108. 

  108. 

  109. <div class="header">
    110. 

  110.   <div class="summary">
    111. 

  111. <a href="#define-members">Macros</a> &#124;
    112. 

  112. <a href="#func-members">Functions</a>  </div>
    113. 

  113.   <div class="headertitle">
    114. 

  114. <div class="title">Softmax Functions<div class="ingroups"><a class="el" href="group__groupNN.html">Neural Network Functions</a></div></div>  </div>
    115. 

  115. </div><!--header-->
    116. 

  116. <div class="contents">
    117. 

  117. <table class="memberdecls">
    118. 

  118. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
    119. 

  119. Macros</h2></td></tr>
    120. 

  120. <tr class="memitem:ga3313178e0fcf9138c3cc3b071a043238"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Softmax.html#ga3313178e0fcf9138c3cc3b071a043238">Q7BITS</a></td></tr>
    121. 

  121. <tr class="memdesc:ga3313178e0fcf9138c3cc3b071a043238"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 softmax function.  <a href="#ga3313178e0fcf9138c3cc3b071a043238">More...</a><br/></td></tr>
    122. 

  122. <tr class="separator:ga3313178e0fcf9138c3cc3b071a043238"><td class="memSeparator" colspan="2">&#160;</td></tr>
    123. 

  123. <tr class="memitem:ga99133c0c13daf247a40419a385d29190"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Softmax.html#ga99133c0c13daf247a40419a385d29190">LOG2Q7BITS</a></td></tr>
    124. 

  124. <tr class="separator:ga99133c0c13daf247a40419a385d29190"><td class="memSeparator" colspan="2">&#160;</td></tr>
    125. 

  125. </table><table class="memberdecls">
    126. 

  126. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    127. 

  127. Functions</h2></td></tr>
    128. 

  128. <tr class="memitem:ga1cacd8b84b8363079311987d0016ebe5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Softmax.html#ga1cacd8b84b8363079311987d0016ebe5">arm_softmax_q15</a> (const q15_t *vec_in, const uint16_t dim_vec, q15_t *p_out)</td></tr>
    129. 

  129. <tr class="memdesc:ga1cacd8b84b8363079311987d0016ebe5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q15 softmax function.  <a href="#ga1cacd8b84b8363079311987d0016ebe5">More...</a><br/></td></tr>
    130. 

  130. <tr class="separator:ga1cacd8b84b8363079311987d0016ebe5"><td class="memSeparator" colspan="2">&#160;</td></tr>
    131. 

  131. <tr class="memitem:ga89aff212a97a3cf32d9d7ddf11a8f43e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Softmax.html#ga89aff212a97a3cf32d9d7ddf11a8f43e">arm_softmax_q7</a> (const q7_t *vec_in, const uint16_t dim_vec, q7_t *p_out)</td></tr>
    132. 

  132. <tr class="memdesc:ga89aff212a97a3cf32d9d7ddf11a8f43e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 softmax function.  <a href="#ga89aff212a97a3cf32d9d7ddf11a8f43e">More...</a><br/></td></tr>
    133. 

  133. <tr class="separator:ga89aff212a97a3cf32d9d7ddf11a8f43e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    134. 

  134. <tr class="memitem:gaf309cdd53978a85a39c9bfdc476aea17"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Softmax.html#gaf309cdd53978a85a39c9bfdc476aea17">arm_softmax_s8</a> (const int8_t *input, const int32_t num_rows, const int32_t row_size, const int32_t mult, const int32_t shift, const int32_t diff_min, int8_t *output)</td></tr>
    135. 

  135. <tr class="memdesc:gaf309cdd53978a85a39c9bfdc476aea17"><td class="mdescLeft">&#160;</td><td class="mdescRight">S8 softmax function.  <a href="#gaf309cdd53978a85a39c9bfdc476aea17">More...</a><br/></td></tr>
    136. 

  136. <tr class="separator:gaf309cdd53978a85a39c9bfdc476aea17"><td class="memSeparator" colspan="2">&#160;</td></tr>
    137. 

  137. <tr class="memitem:gaa1627ed96bd597a8046d00689f077dce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Softmax.html#gaa1627ed96bd597a8046d00689f077dce">arm_softmax_u8</a> (const uint8_t *input, const int32_t num_rows, const int32_t row_size, const int32_t mult, const int32_t shift, const int32_t diff_min, uint8_t *output)</td></tr>
    138. 

  138. <tr class="memdesc:gaa1627ed96bd597a8046d00689f077dce"><td class="mdescLeft">&#160;</td><td class="mdescRight">U8 softmax function.  <a href="#gaa1627ed96bd597a8046d00689f077dce">More...</a><br/></td></tr>
    139. 

  139. <tr class="separator:gaa1627ed96bd597a8046d00689f077dce"><td class="memSeparator" colspan="2">&#160;</td></tr>
    140. 

  140. <tr class="memitem:ga894cfd80c260b946702755b5754e520f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Softmax.html#ga894cfd80c260b946702755b5754e520f">arm_softmax_with_batch_q7</a> (const q7_t *vec_in, const uint16_t nb_batches, const uint16_t dim_vec, q7_t *p_out)</td></tr>
    141. 

  141. <tr class="memdesc:ga894cfd80c260b946702755b5754e520f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 softmax function with batch parameter.  <a href="#ga894cfd80c260b946702755b5754e520f">More...</a><br/></td></tr>
    142. 

  142. <tr class="separator:ga894cfd80c260b946702755b5754e520f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    143. 

  143. </table>
    144. 

  144. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
    145. 

  145. <p>EXP(2) based softmax functions. </p>
    146. 

  146. <h2 class="groupheader">Macro Definition Documentation</h2>
    147. 

  147. <a class="anchor" id="ga99133c0c13daf247a40419a385d29190"></a>
    148. 

  148. <div class="memitem">
    149. 

  149. <div class="memproto">
    150. 

  150.       <table class="memname">
    151. 

  151.         <tr>
    152. 

  152.           <td class="memname">#define LOG2Q7BITS</td>
    153. 

  153.         </tr>
    154. 

  154.       </table>
    155. 

  155. </div><div class="memdoc">
    156. 

  156. 

  157. <p>Referenced by <a class="el" href="group__Softmax.html#ga89aff212a97a3cf32d9d7ddf11a8f43e">arm_softmax_q7()</a>.</p>
    158. 

  158. 

  159. </div>
    160. 

  160. </div>
    161. 

  161. <a class="anchor" id="ga3313178e0fcf9138c3cc3b071a043238"></a>
    162. 

  162. <div class="memitem">
    163. 

  163. <div class="memproto">
    164. 

  164.       <table class="memname">
    165. 

  165.         <tr>
    166. 

  166.           <td class="memname">#define Q7BITS</td>
    167. 

  167.         </tr>
    168. 

  168.       </table>
    169. 

  169. </div><div class="memdoc">
    170. 

  170. <dl class="params"><dt>Parameters</dt><dd>
    171. 

  171.   <table class="params">
    172. 

  172.     <tr><td class="paramdir">[in]</td><td class="paramname">vec_in</td><td>pointer to input vector </td></tr>
    173. 

  173.     <tr><td class="paramdir">[in]</td><td class="paramname">dim_vec</td><td>input vector dimention </td></tr>
    174. 

  174.     <tr><td class="paramdir">[out]</td><td class="paramname">p_out</td><td>pointer to output vector</td></tr>
    175. 

  175.   </table>
    176. 

  176.   </dd>
    177. 

  177. </dl>
    178. 

  178. <p>Here, instead of typical natural logarithm e based softmax, we use 2-based softmax here, i.e.,:</p>
    179. 

  179. <p>y_i = 2^(x_i) / sum(2^x_j)</p>
    180. 

  180. <p>The relative output will be different here. But mathematically, the gradient will be the same with a log(2) scaling factor.</p>
    181. 

  181. <p>If we compare the position of the max value in output of this function with a reference float32 softmax (and thus using exp) we see that the position of the max value is sometimes different.</p>
    182. 

  182. <p>If we do statistics on lot of input vectors we can compute an average error rate in percent. It is the percent of time that the max will be at a position different from the one computed with a reference float32 implementation.</p>
    183. 

  183. <p>This average error rate is dependent on the vector size. We have:</p>
    184. 

  184. <p>Average error rate in percent = -0.555548 + 0.246918 dim_vec Variance of the error rate = -0.0112281 + 0.0382476 dim_vec </p>
    185. 

  185. 

  186. <p>Referenced by <a class="el" href="group__Softmax.html#ga89aff212a97a3cf32d9d7ddf11a8f43e">arm_softmax_q7()</a>.</p>
    187. 

  187. 

  188. </div>
    189. 

  189. </div>
    190. 

  190. <h2 class="groupheader">Function Documentation</h2>
    191. 

  191. <a class="anchor" id="ga1cacd8b84b8363079311987d0016ebe5"></a>
    192. 

  192. <div class="memitem">
    193. 

  193. <div class="memproto">
    194. 

  194.       <table class="memname">
    195. 

  195.         <tr>
    196. 

  196.           <td class="memname">void arm_softmax_q15 </td>
    197. 

  197.           <td>(</td>
    198. 

  198.           <td class="paramtype">const q15_t *&#160;</td>
    199. 

  199.           <td class="paramname"><em>vec_in</em>, </td>
    200. 

  200.         </tr>
    201. 

  201.         <tr>
    202. 

  202.           <td class="paramkey"></td>
    203. 

  203.           <td></td>
    204. 

  204.           <td class="paramtype">const uint16_t&#160;</td>
    205. 

  205.           <td class="paramname"><em>dim_vec</em>, </td>
    206. 

  206.         </tr>
    207. 

  207.         <tr>
    208. 

  208.           <td class="paramkey"></td>
    209. 

  209.           <td></td>
    210. 

  210.           <td class="paramtype">q15_t *&#160;</td>
    211. 

  211.           <td class="paramname"><em>p_out</em>&#160;</td>
    212. 

  212.         </tr>
    213. 

  213.         <tr>
    214. 

  214.           <td></td>
    215. 

  215.           <td>)</td>
    216. 

  216.           <td></td><td></td>
    217. 

  217.         </tr>
    218. 

  218.       </table>
    219. 

  219. </div><div class="memdoc">
    220. 

  220. <dl class="params"><dt>Parameters</dt><dd>
    221. 

  221.   <table class="params">
    222. 

  222.     <tr><td class="paramdir">[in]</td><td class="paramname">vec_in</td><td>pointer to input vector </td></tr>
    223. 

  223.     <tr><td class="paramdir">[in]</td><td class="paramname">dim_vec</td><td>input vector dimention </td></tr>
    224. 

  224.     <tr><td class="paramdir">[out]</td><td class="paramname">p_out</td><td>pointer to output vector</td></tr>
    225. 

  225.   </table>
    226. 

  226.   </dd>
    227. 

  227. </dl>
    228. 

  228. <p>Here, instead of typical e based softmax, we use 2-based softmax, i.e.,:</p>
    229. 

  229. <p>y_i = 2^(x_i) / sum(2^x_j)</p>
    230. 

  230. <p>The relative output will be different here. But mathematically, the gradient will be the same with a log(2) scaling factor. </p>
    231. 

  231. 

  232. </div>
    233. 

  233. </div>
    234. 

  234. <a class="anchor" id="ga89aff212a97a3cf32d9d7ddf11a8f43e"></a>
    235. 

  235. <div class="memitem">
    236. 

  236. <div class="memproto">
    237. 

  237.       <table class="memname">
    238. 

  238.         <tr>
    239. 

  239.           <td class="memname">void arm_softmax_q7 </td>
    240. 

  240.           <td>(</td>
    241. 

  241.           <td class="paramtype">const q7_t *&#160;</td>
    242. 

  242.           <td class="paramname"><em>vec_in</em>, </td>
    243. 

  243.         </tr>
    244. 

  244.         <tr>
    245. 

  245.           <td class="paramkey"></td>
    246. 

  246.           <td></td>
    247. 

  247.           <td class="paramtype">const uint16_t&#160;</td>
    248. 

  248.           <td class="paramname"><em>dim_vec</em>, </td>
    249. 

  249.         </tr>
    250. 

  250.         <tr>
    251. 

  251.           <td class="paramkey"></td>
    252. 

  252.           <td></td>
    253. 

  253.           <td class="paramtype">q7_t *&#160;</td>
    254. 

  254.           <td class="paramname"><em>p_out</em>&#160;</td>
    255. 

  255.         </tr>
    256. 

  256.         <tr>
    257. 

  257.           <td></td>
    258. 

  258.           <td>)</td>
    259. 

  259.           <td></td><td></td>
    260. 

  260.         </tr>
    261. 

  261.       </table>
    262. 

  262. </div><div class="memdoc">
    263. 

  263. <dl class="params"><dt>Parameters</dt><dd>
    264. 

  264.   <table class="params">
    265. 

  265.     <tr><td class="paramdir">[in]</td><td class="paramname">vec_in</td><td>pointer to input vector </td></tr>
    266. 

  266.     <tr><td class="paramdir">[in]</td><td class="paramname">dim_vec</td><td>input vector dimension </td></tr>
    267. 

  267.     <tr><td class="paramdir">[out]</td><td class="paramname">p_out</td><td>pointer to output vector</td></tr>
    268. 

  268.   </table>
    269. 

  269.   </dd>
    270. 

  270. </dl>
    271. 

  271. <dl class="section note"><dt>Note</dt><dd>This function is an optimized version which is not bit-accurate with TensorFlow Lite's kernel </dd></dl>
    272. 

  272. 

  273. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#ac9f7be20432a6926ac07c1f44b1b02fe">arm_nn_read_q7x4_ia()</a>, <a class="el" href="group__Softmax.html#ga99133c0c13daf247a40419a385d29190">LOG2Q7BITS</a>, and <a class="el" href="group__Softmax.html#ga3313178e0fcf9138c3cc3b071a043238">Q7BITS</a>.</p>
    274. 

  274. 

  275. <p>Referenced by <a class="el" href="group__Softmax.html#ga894cfd80c260b946702755b5754e520f">arm_softmax_with_batch_q7()</a>, and <a class="el" href="arm__nnexamples__cifar10_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>
    276. 

  276. 

  277. </div>
    278. 

  278. </div>
    279. 

  279. <a class="anchor" id="gaf309cdd53978a85a39c9bfdc476aea17"></a>
    280. 

  280. <div class="memitem">
    281. 

  281. <div class="memproto">
    282. 

  282.       <table class="memname">
    283. 

  283.         <tr>
    284. 

  284.           <td class="memname">void arm_softmax_s8 </td>
    285. 

  285.           <td>(</td>
    286. 

  286.           <td class="paramtype">const int8_t *&#160;</td>
    287. 

  287.           <td class="paramname"><em>input</em>, </td>
    288. 

  288.         </tr>
    289. 

  289.         <tr>
    290. 

  290.           <td class="paramkey"></td>
    291. 

  291.           <td></td>
    292. 

  292.           <td class="paramtype">const int32_t&#160;</td>
    293. 

  293.           <td class="paramname"><em>num_rows</em>, </td>
    294. 

  294.         </tr>
    295. 

  295.         <tr>
    296. 

  296.           <td class="paramkey"></td>
    297. 

  297.           <td></td>
    298. 

  298.           <td class="paramtype">const int32_t&#160;</td>
    299. 

  299.           <td class="paramname"><em>row_size</em>, </td>
    300. 

  300.         </tr>
    301. 

  301.         <tr>
    302. 

  302.           <td class="paramkey"></td>
    303. 

  303.           <td></td>
    304. 

  304.           <td class="paramtype">const int32_t&#160;</td>
    305. 

  305.           <td class="paramname"><em>mult</em>, </td>
    306. 

  306.         </tr>
    307. 

  307.         <tr>
    308. 

  308.           <td class="paramkey"></td>
    309. 

  309.           <td></td>
    310. 

  310.           <td class="paramtype">const int32_t&#160;</td>
    311. 

  311.           <td class="paramname"><em>shift</em>, </td>
    312. 

  312.         </tr>
    313. 

  313.         <tr>
    314. 

  314.           <td class="paramkey"></td>
    315. 

  315.           <td></td>
    316. 

  316.           <td class="paramtype">const int32_t&#160;</td>
    317. 

  317.           <td class="paramname"><em>diff_min</em>, </td>
    318. 

  318.         </tr>
    319. 

  319.         <tr>
    320. 

  320.           <td class="paramkey"></td>
    321. 

  321.           <td></td>
    322. 

  322.           <td class="paramtype">int8_t *&#160;</td>
    323. 

  323.           <td class="paramname"><em>output</em>&#160;</td>
    324. 

  324.         </tr>
    325. 

  325.         <tr>
    326. 

  326.           <td></td>
    327. 

  327.           <td>)</td>
    328. 

  328.           <td></td><td></td>
    329. 

  329.         </tr>
    330. 

  330.       </table>
    331. 

  331. </div><div class="memdoc">
    332. 

  332. <dl class="params"><dt>Parameters</dt><dd>
    333. 

  333.   <table class="params">
    334. 

  334.     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Pointer to the input tensor </td></tr>
    335. 

  335.     <tr><td class="paramdir">[in]</td><td class="paramname">num_rows</td><td>Number of rows in the input tensor </td></tr>
    336. 

  336.     <tr><td class="paramdir">[in]</td><td class="paramname">row_size</td><td>Number of elements in each input row </td></tr>
    337. 

  337.     <tr><td class="paramdir">[in]</td><td class="paramname">mult</td><td>Input quantization multiplier </td></tr>
    338. 

  338.     <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>Input quantization shift within the range [0, 31] </td></tr>
    339. 

  339.     <tr><td class="paramdir">[in]</td><td class="paramname">diff_min</td><td>Minimum difference with max in row. Used to check if the quantized exponential operation can be performed </td></tr>
    340. 

  340.     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Pointer to the output tensor</td></tr>
    341. 

  341.   </table>
    342. 

  342.   </dd>
    343. 

  343. </dl>
    344. 

  344. <dl class="section note"><dt>Note</dt><dd>Supported framework: TensorFlow Lite micro (bit-accurate) </dd></dl>
    345. 

  345. 

  346. <p>References <a class="el" href="arm__softmax__s8_8c.html#a401e2dfaf6a8f0ef34f15295e026fd79">ACCUM_BITS</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#abe05f0e80d965ae31dec16ba4063f48a">CLAMP</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a7ce5ee6d8839bf541fb4bbdf4ef80eb1">DIV_POW2</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a0e4379e9eef514ce88d02b5dfbff256d">DIV_POW2_MVE</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a97055bb1e8a21ead129caecdfb24cfb1">EXP_ON_NEG</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a518f7e0db18bea6b61a2b88f266aef20">MUL_SAT</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a6349818fec8167dff87c3fb7ca81fc1c">MUL_SAT_MVE</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#a82ac477c930f5b05e8f71f6f61e405a8">ONE_OVER1</a>.</p>
    347. 

  347. 

  348. </div>
    349. 

  349. </div>
    350. 

  350. <a class="anchor" id="gaa1627ed96bd597a8046d00689f077dce"></a>
    351. 

  351. <div class="memitem">
    352. 

  352. <div class="memproto">
    353. 

  353.       <table class="memname">
    354. 

  354.         <tr>
    355. 

  355.           <td class="memname">void arm_softmax_u8 </td>
    356. 

  356.           <td>(</td>
    357. 

  357.           <td class="paramtype">const uint8_t *&#160;</td>
    358. 

  358.           <td class="paramname"><em>input</em>, </td>
    359. 

  359.         </tr>
    360. 

  360.         <tr>
    361. 

  361.           <td class="paramkey"></td>
    362. 

  362.           <td></td>
    363. 

  363.           <td class="paramtype">const int32_t&#160;</td>
    364. 

  364.           <td class="paramname"><em>num_rows</em>, </td>
    365. 

  365.         </tr>
    366. 

  366.         <tr>
    367. 

  367.           <td class="paramkey"></td>
    368. 

  368.           <td></td>
    369. 

  369.           <td class="paramtype">const int32_t&#160;</td>
    370. 

  370.           <td class="paramname"><em>row_size</em>, </td>
    371. 

  371.         </tr>
    372. 

  372.         <tr>
    373. 

  373.           <td class="paramkey"></td>
    374. 

  374.           <td></td>
    375. 

  375.           <td class="paramtype">const int32_t&#160;</td>
    376. 

  376.           <td class="paramname"><em>mult</em>, </td>
    377. 

  377.         </tr>
    378. 

  378.         <tr>
    379. 

  379.           <td class="paramkey"></td>
    380. 

  380.           <td></td>
    381. 

  381.           <td class="paramtype">const int32_t&#160;</td>
    382. 

  382.           <td class="paramname"><em>shift</em>, </td>
    383. 

  383.         </tr>
    384. 

  384.         <tr>
    385. 

  385.           <td class="paramkey"></td>
    386. 

  386.           <td></td>
    387. 

  387.           <td class="paramtype">const int32_t&#160;</td>
    388. 

  388.           <td class="paramname"><em>diff_min</em>, </td>
    389. 

  389.         </tr>
    390. 

  390.         <tr>
    391. 

  391.           <td class="paramkey"></td>
    392. 

  392.           <td></td>
    393. 

  393.           <td class="paramtype">uint8_t *&#160;</td>
    394. 

  394.           <td class="paramname"><em>output</em>&#160;</td>
    395. 

  395.         </tr>
    396. 

  396.         <tr>
    397. 

  397.           <td></td>
    398. 

  398.           <td>)</td>
    399. 

  399.           <td></td><td></td>
    400. 

  400.         </tr>
    401. 

  401.       </table>
    402. 

  402. </div><div class="memdoc">
    403. 

  403. <dl class="params"><dt>Parameters</dt><dd>
    404. 

  404.   <table class="params">
    405. 

  405.     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Pointer to the input tensor </td></tr>
    406. 

  406.     <tr><td class="paramdir">[in]</td><td class="paramname">num_rows</td><td>Number of rows in the input tensor </td></tr>
    407. 

  407.     <tr><td class="paramdir">[in]</td><td class="paramname">row_size</td><td>Number of elements in each input row </td></tr>
    408. 

  408.     <tr><td class="paramdir">[in]</td><td class="paramname">mult</td><td>Input quantization multiplier </td></tr>
    409. 

  409.     <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>Input quantization shift within the range [0, 31] </td></tr>
    410. 

  410.     <tr><td class="paramdir">[in]</td><td class="paramname">diff_min</td><td>Minimum difference with max in row. Used to check if the quantized exponential operation can be performed </td></tr>
    411. 

  411.     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Pointer to the output tensor</td></tr>
    412. 

  412.   </table>
    413. 

  413.   </dd>
    414. 

  414. </dl>
    415. 

  415. <dl class="section note"><dt>Note</dt><dd>Supported framework: TensorFlow Lite micro (bit-accurate) </dd></dl>
    416. 

  416. 

  417. <p>References <a class="el" href="arm__softmax__u8_8c.html#a401e2dfaf6a8f0ef34f15295e026fd79">ACCUM_BITS</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#abe05f0e80d965ae31dec16ba4063f48a">CLAMP</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a7ce5ee6d8839bf541fb4bbdf4ef80eb1">DIV_POW2</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a97055bb1e8a21ead129caecdfb24cfb1">EXP_ON_NEG</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a518f7e0db18bea6b61a2b88f266aef20">MUL_SAT</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#a82ac477c930f5b05e8f71f6f61e405a8">ONE_OVER1</a>.</p>
    418. 

  418. 

  419. </div>
    420. 

  420. </div>
    421. 

  421. <a class="anchor" id="ga894cfd80c260b946702755b5754e520f"></a>
    422. 

  422. <div class="memitem">
    423. 

  423. <div class="memproto">
    424. 

  424.       <table class="memname">
    425. 

  425.         <tr>
    426. 

  426.           <td class="memname">void arm_softmax_with_batch_q7 </td>
    427. 

  427.           <td>(</td>
    428. 

  428.           <td class="paramtype">const q7_t *&#160;</td>
    429. 

  429.           <td class="paramname"><em>vec_in</em>, </td>
    430. 

  430.         </tr>
    431. 

  431.         <tr>
    432. 

  432.           <td class="paramkey"></td>
    433. 

  433.           <td></td>
    434. 

  434.           <td class="paramtype">const uint16_t&#160;</td>
    435. 

  435.           <td class="paramname"><em>nb_batches</em>, </td>
    436. 

  436.         </tr>
    437. 

  437.         <tr>
    438. 

  438.           <td class="paramkey"></td>
    439. 

  439.           <td></td>
    440. 

  440.           <td class="paramtype">const uint16_t&#160;</td>
    441. 

  441.           <td class="paramname"><em>dim_vec</em>, </td>
    442. 

  442.         </tr>
    443. 

  443.         <tr>
    444. 

  444.           <td class="paramkey"></td>
    445. 

  445.           <td></td>
    446. 

  446.           <td class="paramtype">q7_t *&#160;</td>
    447. 

  447.           <td class="paramname"><em>p_out</em>&#160;</td>
    448. 

  448.         </tr>
    449. 

  449.         <tr>
    450. 

  450.           <td></td>
    451. 

  451.           <td>)</td>
    452. 

  452.           <td></td><td></td>
    453. 

  453.         </tr>
    454. 

  454.       </table>
    455. 

  455. </div><div class="memdoc">
    456. 

  456. <dl class="params"><dt>Parameters</dt><dd>
    457. 

  457.   <table class="params">
    458. 

  458.     <tr><td class="paramdir">[in]</td><td class="paramname">vec_in</td><td>pointer to input vector </td></tr>
    459. 

  459.     <tr><td class="paramdir">[in]</td><td class="paramname">nb_batches</td><td>number of batches </td></tr>
    460. 

  460.     <tr><td class="paramdir">[in]</td><td class="paramname">dim_vec</td><td>input vector dimention </td></tr>
    461. 

  461.     <tr><td class="paramdir">[out]</td><td class="paramname">p_out</td><td>pointer to output vector</td></tr>
    462. 

  462.   </table>
    463. 

  463.   </dd>
    464. 

  464. </dl>
    465. 

  465. <p>Here, instead of typical natural logarithm e based softmax, we use 2-based softmax here, i.e.,:</p>
    466. 

  466. <p>y_i = 2^(x_i) / sum(2^x_j)</p>
    467. 

  467. <p>The relative output will be different here. But mathematically, the gradient will be the same with a log(2) scaling factor. </p>
    468. 

  468. 

  469. <p>References <a class="el" href="group__Softmax.html#ga89aff212a97a3cf32d9d7ddf11a8f43e">arm_softmax_q7()</a>.</p>
    470. 

  470. 

  471. </div>
    472. 

  472. </div>
    473. 

  473. </div><!-- contents -->
    474. 

  474. </div><!-- doc-content -->
    475. 

  475. <!-- start footer part -->
    476. 

  476. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    477. 

  477.   <ul>
    478. 

  478.     <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.
    479. 

  479. 	<!--
    480. 

  480.     <a href="http://www.doxygen.org/index.html">
    481. 

  481.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
    482. 

  482. 	-->
    483. 

  483. 	</li>
    484. 

  484.   </ul>
    485. 

  485. </div>
    486. 

  486. </body>
    487. 

  487. </html>
    488.