group__FC.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755
  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>Fully-connected Layer Functions</title>
  7. <title>CMSIS-NN: Fully-connected Layer 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.2.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__FC.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">Fully-connected Layer 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:ga4a1521e7532a1e62d71f3b12762016e2"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FC.html#ga4a1521e7532a1e62d71f3b12762016e2">arm_fully_connected_mat_q7_vec_q15</a> (const q15_t *pV, const q7_t *pM, const uint16_t dim_vec, const uint16_t num_of_rows, const uint16_t bias_shift, const uint16_t out_shift, const q7_t *bias, q15_t *pOut, q15_t *vec_buffer)</td></tr>
  118. <tr class="memdesc:ga4a1521e7532a1e62d71f3b12762016e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mixed Q15-Q7 fully-connected layer function. <a href="#ga4a1521e7532a1e62d71f3b12762016e2">More...</a><br/></td></tr>
  119. <tr class="separator:ga4a1521e7532a1e62d71f3b12762016e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:gae3857bb6375692e81dde8cbd70adec08"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FC.html#gae3857bb6375692e81dde8cbd70adec08">arm_fully_connected_mat_q7_vec_q15_opt</a> (const q15_t *pV, const q7_t *pM, const uint16_t dim_vec, const uint16_t num_of_rows, const uint16_t bias_shift, const uint16_t out_shift, const q7_t *bias, q15_t *pOut, q15_t *vec_buffer)</td></tr>
  121. <tr class="memdesc:gae3857bb6375692e81dde8cbd70adec08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mixed Q15-Q7 opt fully-connected layer function. <a href="#gae3857bb6375692e81dde8cbd70adec08">More...</a><br/></td></tr>
  122. <tr class="separator:gae3857bb6375692e81dde8cbd70adec08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:gaac666c212b209e636c2369dd5c75d0dc"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FC.html#gaac666c212b209e636c2369dd5c75d0dc">arm_fully_connected_q15</a> (const q15_t *pV, const q15_t *pM, const uint16_t dim_vec, const uint16_t num_of_rows, const uint16_t bias_shift, const uint16_t out_shift, const q15_t *bias, q15_t *pOut, q15_t *vec_buffer)</td></tr>
  124. <tr class="memdesc:gaac666c212b209e636c2369dd5c75d0dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q15 opt fully-connected layer function. <a href="#gaac666c212b209e636c2369dd5c75d0dc">More...</a><br/></td></tr>
  125. <tr class="separator:gaac666c212b209e636c2369dd5c75d0dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:ga062912078da113f5dd2004fd919a0ff2"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FC.html#ga062912078da113f5dd2004fd919a0ff2">arm_fully_connected_q15_opt</a> (const q15_t *pV, const q15_t *pM, const uint16_t dim_vec, const uint16_t num_of_rows, const uint16_t bias_shift, const uint16_t out_shift, const q15_t *bias, q15_t *pOut, q15_t *vec_buffer)</td></tr>
  127. <tr class="memdesc:ga062912078da113f5dd2004fd919a0ff2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q15 opt fully-connected layer function. <a href="#ga062912078da113f5dd2004fd919a0ff2">More...</a><br/></td></tr>
  128. <tr class="separator:ga062912078da113f5dd2004fd919a0ff2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ga8b7e0c2e989e8c75f0dc789f3115323d"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FC.html#ga8b7e0c2e989e8c75f0dc789f3115323d">arm_fully_connected_q7</a> (const q7_t *pV, const q7_t *pM, const uint16_t dim_vec, const uint16_t num_of_rows, const uint16_t bias_shift, const uint16_t out_shift, const q7_t *bias, q7_t *pOut, q15_t *vec_buffer)</td></tr>
  130. <tr class="memdesc:ga8b7e0c2e989e8c75f0dc789f3115323d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 basic fully-connected layer function. <a href="#ga8b7e0c2e989e8c75f0dc789f3115323d">More...</a><br/></td></tr>
  131. <tr class="separator:ga8b7e0c2e989e8c75f0dc789f3115323d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:gaf82b71ef472a38f8fc9ac414d9d07e67"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FC.html#gaf82b71ef472a38f8fc9ac414d9d07e67">arm_fully_connected_q7_opt</a> (const q7_t *pV, const q7_t *pM, const uint16_t dim_vec, const uint16_t num_of_rows, const uint16_t bias_shift, const uint16_t out_shift, const q7_t *bias, q7_t *pOut, q15_t *vec_buffer)</td></tr>
  133. <tr class="memdesc:gaf82b71ef472a38f8fc9ac414d9d07e67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 opt fully-connected layer function. <a href="#gaf82b71ef472a38f8fc9ac414d9d07e67">More...</a><br/></td></tr>
  134. <tr class="separator:gaf82b71ef472a38f8fc9ac414d9d07e67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table>
  136. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  137. <p>Perform fully-connected layer</p>
  138. <p>Fully-connected layer is basically a matrix-vector multiplication with bias. The matrix is the weights and the input/output vectors are the activation values. Supported {weight, activation} precisions include {8-bit, 8-bit}, {16-bit, 16-bit}, and {8-bit, 16-bit}.</p>
  139. <p>Here we have two types of kernel functions. The basic function implements the function using regular GEMV approach. The opt functions operates with weights in interleaved formats. </p>
  140. <h2 class="groupheader">Function Documentation</h2>
  141. <a class="anchor" id="ga4a1521e7532a1e62d71f3b12762016e2"></a>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">arm_status arm_fully_connected_mat_q7_vec_q15 </td>
  147. <td>(</td>
  148. <td class="paramtype">const q15_t *&#160;</td>
  149. <td class="paramname"><em>pV</em>, </td>
  150. </tr>
  151. <tr>
  152. <td class="paramkey"></td>
  153. <td></td>
  154. <td class="paramtype">const q7_t *&#160;</td>
  155. <td class="paramname"><em>pM</em>, </td>
  156. </tr>
  157. <tr>
  158. <td class="paramkey"></td>
  159. <td></td>
  160. <td class="paramtype">const uint16_t&#160;</td>
  161. <td class="paramname"><em>dim_vec</em>, </td>
  162. </tr>
  163. <tr>
  164. <td class="paramkey"></td>
  165. <td></td>
  166. <td class="paramtype">const uint16_t&#160;</td>
  167. <td class="paramname"><em>num_of_rows</em>, </td>
  168. </tr>
  169. <tr>
  170. <td class="paramkey"></td>
  171. <td></td>
  172. <td class="paramtype">const uint16_t&#160;</td>
  173. <td class="paramname"><em>bias_shift</em>, </td>
  174. </tr>
  175. <tr>
  176. <td class="paramkey"></td>
  177. <td></td>
  178. <td class="paramtype">const uint16_t&#160;</td>
  179. <td class="paramname"><em>out_shift</em>, </td>
  180. </tr>
  181. <tr>
  182. <td class="paramkey"></td>
  183. <td></td>
  184. <td class="paramtype">const q7_t *&#160;</td>
  185. <td class="paramname"><em>bias</em>, </td>
  186. </tr>
  187. <tr>
  188. <td class="paramkey"></td>
  189. <td></td>
  190. <td class="paramtype">q15_t *&#160;</td>
  191. <td class="paramname"><em>pOut</em>, </td>
  192. </tr>
  193. <tr>
  194. <td class="paramkey"></td>
  195. <td></td>
  196. <td class="paramtype">q15_t *&#160;</td>
  197. <td class="paramname"><em>vec_buffer</em>&#160;</td>
  198. </tr>
  199. <tr>
  200. <td></td>
  201. <td>)</td>
  202. <td></td><td></td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <dl class="params"><dt>Parameters</dt><dd>
  207. <table class="params">
  208. <tr><td class="paramdir">[in]</td><td class="paramname">pV</td><td>pointer to input vector </td></tr>
  209. <tr><td class="paramdir">[in]</td><td class="paramname">pM</td><td>pointer to matrix weights </td></tr>
  210. <tr><td class="paramdir">[in]</td><td class="paramname">dim_vec</td><td>length of the vector </td></tr>
  211. <tr><td class="paramdir">[in]</td><td class="paramname">num_of_rows</td><td>number of rows in weight matrix </td></tr>
  212. <tr><td class="paramdir">[in]</td><td class="paramname">bias_shift</td><td>amount of left-shift for bias </td></tr>
  213. <tr><td class="paramdir">[in]</td><td class="paramname">out_shift</td><td>amount of right-shift for output </td></tr>
  214. <tr><td class="paramdir">[in]</td><td class="paramname">bias</td><td>pointer to bias </td></tr>
  215. <tr><td class="paramdir">[in,out]</td><td class="paramname">pOut</td><td>pointer to output vector </td></tr>
  216. <tr><td class="paramdir">[in,out]</td><td class="paramname">vec_buffer</td><td>pointer to buffer space for input </td></tr>
  217. </table>
  218. </dd>
  219. </dl>
  220. <dl class="section return"><dt>Returns</dt><dd>The function returns <code>ARM_MATH_SUCCESS</code></dd></dl>
  221. <p><b>Buffer size:</b></p>
  222. <p>vec_buffer size: 0</p>
  223. <p>Q7_Q15 version of the fully connected layer</p>
  224. <p>Weights are in q7_t and Activations are in q15_t </p>
  225. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a4cbd428a2b4a4f6b2a6e4219520c7ce0">NN_ROUND</a>.</p>
  226. <p>Referenced by <a class="el" href="arm__nnexamples__gru_8cpp.html#ac71a806472c7c0c284a2253e71a6a27b">gru_example()</a>.</p>
  227. </div>
  228. </div>
  229. <a class="anchor" id="gae3857bb6375692e81dde8cbd70adec08"></a>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname">arm_status arm_fully_connected_mat_q7_vec_q15_opt </td>
  235. <td>(</td>
  236. <td class="paramtype">const q15_t *&#160;</td>
  237. <td class="paramname"><em>pV</em>, </td>
  238. </tr>
  239. <tr>
  240. <td class="paramkey"></td>
  241. <td></td>
  242. <td class="paramtype">const q7_t *&#160;</td>
  243. <td class="paramname"><em>pM</em>, </td>
  244. </tr>
  245. <tr>
  246. <td class="paramkey"></td>
  247. <td></td>
  248. <td class="paramtype">const uint16_t&#160;</td>
  249. <td class="paramname"><em>dim_vec</em>, </td>
  250. </tr>
  251. <tr>
  252. <td class="paramkey"></td>
  253. <td></td>
  254. <td class="paramtype">const uint16_t&#160;</td>
  255. <td class="paramname"><em>num_of_rows</em>, </td>
  256. </tr>
  257. <tr>
  258. <td class="paramkey"></td>
  259. <td></td>
  260. <td class="paramtype">const uint16_t&#160;</td>
  261. <td class="paramname"><em>bias_shift</em>, </td>
  262. </tr>
  263. <tr>
  264. <td class="paramkey"></td>
  265. <td></td>
  266. <td class="paramtype">const uint16_t&#160;</td>
  267. <td class="paramname"><em>out_shift</em>, </td>
  268. </tr>
  269. <tr>
  270. <td class="paramkey"></td>
  271. <td></td>
  272. <td class="paramtype">const q7_t *&#160;</td>
  273. <td class="paramname"><em>bias</em>, </td>
  274. </tr>
  275. <tr>
  276. <td class="paramkey"></td>
  277. <td></td>
  278. <td class="paramtype">q15_t *&#160;</td>
  279. <td class="paramname"><em>pOut</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype">q15_t *&#160;</td>
  285. <td class="paramname"><em>vec_buffer</em>&#160;</td>
  286. </tr>
  287. <tr>
  288. <td></td>
  289. <td>)</td>
  290. <td></td><td></td>
  291. </tr>
  292. </table>
  293. </div><div class="memdoc">
  294. <dl class="params"><dt>Parameters</dt><dd>
  295. <table class="params">
  296. <tr><td class="paramdir">[in]</td><td class="paramname">pV</td><td>pointer to input vector </td></tr>
  297. <tr><td class="paramdir">[in]</td><td class="paramname">pM</td><td>pointer to matrix weights </td></tr>
  298. <tr><td class="paramdir">[in]</td><td class="paramname">dim_vec</td><td>length of the vector </td></tr>
  299. <tr><td class="paramdir">[in]</td><td class="paramname">num_of_rows</td><td>number of rows in weight matrix </td></tr>
  300. <tr><td class="paramdir">[in]</td><td class="paramname">bias_shift</td><td>amount of left-shift for bias </td></tr>
  301. <tr><td class="paramdir">[in]</td><td class="paramname">out_shift</td><td>amount of right-shift for output </td></tr>
  302. <tr><td class="paramdir">[in]</td><td class="paramname">bias</td><td>pointer to bias </td></tr>
  303. <tr><td class="paramdir">[in,out]</td><td class="paramname">pOut</td><td>pointer to output vector </td></tr>
  304. <tr><td class="paramdir">[in,out]</td><td class="paramname">vec_buffer</td><td>pointer to buffer space for input </td></tr>
  305. </table>
  306. </dd>
  307. </dl>
  308. <dl class="section return"><dt>Returns</dt><dd>The function returns <code>ARM_MATH_SUCCESS</code></dd></dl>
  309. <p><b>Buffer size:</b></p>
  310. <p>vec_buffer size: 0</p>
  311. <p>Q7_Q15 version of the fully connected layer</p>
  312. <p>Weights are in q7_t and Activations are in q15_t</p>
  313. <p>Limitation: x4 version requires weight reordering to work</p>
  314. <p>Here we use only one pointer to read 4 rows in the weight matrix. So if the original q7_t matrix looks like this:</p>
  315. <p>| a11 | a12 | a13 | a14 | a15 | a16 | a17 |</p>
  316. <p>| a21 | a22 | a23 | a24 | a25 | a26 | a27 |</p>
  317. <p>| a31 | a32 | a33 | a34 | a35 | a36 | a37 |</p>
  318. <p>| a41 | a42 | a43 | a44 | a45 | a46 | a47 |</p>
  319. <p>| a51 | a52 | a53 | a54 | a55 | a56 | a57 |</p>
  320. <p>| a61 | a62 | a63 | a64 | a65 | a66 | a67 |</p>
  321. <p>We operates on multiple-of-4 rows, so the first four rows becomes</p>
  322. <p>| a11 | a21 | a12 | a22 | a31 | a41 | a32 | a42 |</p>
  323. <p>| a13 | a23 | a14 | a24 | a33 | a43 | a34 | a44 |</p>
  324. <p>| a15 | a25 | a16 | a26 | a35 | a45 | a36 | a46 |</p>
  325. <p>The column left over will be in-order. which is: | a17 | a27 | a37 | a47 |</p>
  326. <p>For the left-over rows, we do 1x1 computation, so the data remains as its original order.</p>
  327. <p>So the stored weight matrix looks like this:</p>
  328. <p>| a11 | a21 | a12 | a22 | a31 | a41 |</p>
  329. <p>| a32 | a42 | a13 | a23 | a14 | a24 |</p>
  330. <p>| a33 | a43 | a34 | a44 | a15 | a25 |</p>
  331. <p>| a16 | a26 | a35 | a45 | a36 | a46 |</p>
  332. <p>| a17 | a27 | a37 | a47 | a51 | a52 |</p>
  333. <p>| a53 | a54 | a55 | a56 | a57 | a61 |</p>
  334. <p>| a62 | a63 | a64 | a65 | a66 | a67 | </p>
  335. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a4cbd428a2b4a4f6b2a6e4219520c7ce0">NN_ROUND</a>.</p>
  336. <p>Referenced by <a class="el" href="arm__nnexamples__gru_8cpp.html#ac71a806472c7c0c284a2253e71a6a27b">gru_example()</a>.</p>
  337. </div>
  338. </div>
  339. <a class="anchor" id="gaac666c212b209e636c2369dd5c75d0dc"></a>
  340. <div class="memitem">
  341. <div class="memproto">
  342. <table class="memname">
  343. <tr>
  344. <td class="memname">arm_status arm_fully_connected_q15 </td>
  345. <td>(</td>
  346. <td class="paramtype">const q15_t *&#160;</td>
  347. <td class="paramname"><em>pV</em>, </td>
  348. </tr>
  349. <tr>
  350. <td class="paramkey"></td>
  351. <td></td>
  352. <td class="paramtype">const q15_t *&#160;</td>
  353. <td class="paramname"><em>pM</em>, </td>
  354. </tr>
  355. <tr>
  356. <td class="paramkey"></td>
  357. <td></td>
  358. <td class="paramtype">const uint16_t&#160;</td>
  359. <td class="paramname"><em>dim_vec</em>, </td>
  360. </tr>
  361. <tr>
  362. <td class="paramkey"></td>
  363. <td></td>
  364. <td class="paramtype">const uint16_t&#160;</td>
  365. <td class="paramname"><em>num_of_rows</em>, </td>
  366. </tr>
  367. <tr>
  368. <td class="paramkey"></td>
  369. <td></td>
  370. <td class="paramtype">const uint16_t&#160;</td>
  371. <td class="paramname"><em>bias_shift</em>, </td>
  372. </tr>
  373. <tr>
  374. <td class="paramkey"></td>
  375. <td></td>
  376. <td class="paramtype">const uint16_t&#160;</td>
  377. <td class="paramname"><em>out_shift</em>, </td>
  378. </tr>
  379. <tr>
  380. <td class="paramkey"></td>
  381. <td></td>
  382. <td class="paramtype">const q15_t *&#160;</td>
  383. <td class="paramname"><em>bias</em>, </td>
  384. </tr>
  385. <tr>
  386. <td class="paramkey"></td>
  387. <td></td>
  388. <td class="paramtype">q15_t *&#160;</td>
  389. <td class="paramname"><em>pOut</em>, </td>
  390. </tr>
  391. <tr>
  392. <td class="paramkey"></td>
  393. <td></td>
  394. <td class="paramtype">q15_t *&#160;</td>
  395. <td class="paramname"><em>vec_buffer</em>&#160;</td>
  396. </tr>
  397. <tr>
  398. <td></td>
  399. <td>)</td>
  400. <td></td><td></td>
  401. </tr>
  402. </table>
  403. </div><div class="memdoc">
  404. <p>Q15 basic fully-connected layer function.</p>
  405. <dl class="params"><dt>Parameters</dt><dd>
  406. <table class="params">
  407. <tr><td class="paramdir">[in]</td><td class="paramname">pV</td><td>pointer to input vector </td></tr>
  408. <tr><td class="paramdir">[in]</td><td class="paramname">pM</td><td>pointer to matrix weights </td></tr>
  409. <tr><td class="paramdir">[in]</td><td class="paramname">dim_vec</td><td>length of the vector </td></tr>
  410. <tr><td class="paramdir">[in]</td><td class="paramname">num_of_rows</td><td>number of rows in weight matrix </td></tr>
  411. <tr><td class="paramdir">[in]</td><td class="paramname">bias_shift</td><td>amount of left-shift for bias </td></tr>
  412. <tr><td class="paramdir">[in]</td><td class="paramname">out_shift</td><td>amount of right-shift for output </td></tr>
  413. <tr><td class="paramdir">[in]</td><td class="paramname">bias</td><td>pointer to bias </td></tr>
  414. <tr><td class="paramdir">[in,out]</td><td class="paramname">pOut</td><td>pointer to output vector </td></tr>
  415. <tr><td class="paramdir">[in,out]</td><td class="paramname">vec_buffer</td><td>pointer to buffer space for input </td></tr>
  416. </table>
  417. </dd>
  418. </dl>
  419. <dl class="section return"><dt>Returns</dt><dd>The function returns <code>ARM_MATH_SUCCESS</code></dd></dl>
  420. <p><b>Buffer size:</b></p>
  421. <p>vec_buffer size: 0 </p>
  422. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a4cbd428a2b4a4f6b2a6e4219520c7ce0">NN_ROUND</a>.</p>
  423. </div>
  424. </div>
  425. <a class="anchor" id="ga062912078da113f5dd2004fd919a0ff2"></a>
  426. <div class="memitem">
  427. <div class="memproto">
  428. <table class="memname">
  429. <tr>
  430. <td class="memname">arm_status arm_fully_connected_q15_opt </td>
  431. <td>(</td>
  432. <td class="paramtype">const q15_t *&#160;</td>
  433. <td class="paramname"><em>pV</em>, </td>
  434. </tr>
  435. <tr>
  436. <td class="paramkey"></td>
  437. <td></td>
  438. <td class="paramtype">const q15_t *&#160;</td>
  439. <td class="paramname"><em>pM</em>, </td>
  440. </tr>
  441. <tr>
  442. <td class="paramkey"></td>
  443. <td></td>
  444. <td class="paramtype">const uint16_t&#160;</td>
  445. <td class="paramname"><em>dim_vec</em>, </td>
  446. </tr>
  447. <tr>
  448. <td class="paramkey"></td>
  449. <td></td>
  450. <td class="paramtype">const uint16_t&#160;</td>
  451. <td class="paramname"><em>num_of_rows</em>, </td>
  452. </tr>
  453. <tr>
  454. <td class="paramkey"></td>
  455. <td></td>
  456. <td class="paramtype">const uint16_t&#160;</td>
  457. <td class="paramname"><em>bias_shift</em>, </td>
  458. </tr>
  459. <tr>
  460. <td class="paramkey"></td>
  461. <td></td>
  462. <td class="paramtype">const uint16_t&#160;</td>
  463. <td class="paramname"><em>out_shift</em>, </td>
  464. </tr>
  465. <tr>
  466. <td class="paramkey"></td>
  467. <td></td>
  468. <td class="paramtype">const q15_t *&#160;</td>
  469. <td class="paramname"><em>bias</em>, </td>
  470. </tr>
  471. <tr>
  472. <td class="paramkey"></td>
  473. <td></td>
  474. <td class="paramtype">q15_t *&#160;</td>
  475. <td class="paramname"><em>pOut</em>, </td>
  476. </tr>
  477. <tr>
  478. <td class="paramkey"></td>
  479. <td></td>
  480. <td class="paramtype">q15_t *&#160;</td>
  481. <td class="paramname"><em>vec_buffer</em>&#160;</td>
  482. </tr>
  483. <tr>
  484. <td></td>
  485. <td>)</td>
  486. <td></td><td></td>
  487. </tr>
  488. </table>
  489. </div><div class="memdoc">
  490. <dl class="params"><dt>Parameters</dt><dd>
  491. <table class="params">
  492. <tr><td class="paramdir">[in]</td><td class="paramname">pV</td><td>pointer to input vector </td></tr>
  493. <tr><td class="paramdir">[in]</td><td class="paramname">pM</td><td>pointer to matrix weights </td></tr>
  494. <tr><td class="paramdir">[in]</td><td class="paramname">dim_vec</td><td>length of the vector </td></tr>
  495. <tr><td class="paramdir">[in]</td><td class="paramname">num_of_rows</td><td>number of rows in weight matrix </td></tr>
  496. <tr><td class="paramdir">[in]</td><td class="paramname">bias_shift</td><td>amount of left-shift for bias </td></tr>
  497. <tr><td class="paramdir">[in]</td><td class="paramname">out_shift</td><td>amount of right-shift for output </td></tr>
  498. <tr><td class="paramdir">[in]</td><td class="paramname">bias</td><td>pointer to bias </td></tr>
  499. <tr><td class="paramdir">[in,out]</td><td class="paramname">pOut</td><td>pointer to output vector </td></tr>
  500. <tr><td class="paramdir">[in,out]</td><td class="paramname">vec_buffer</td><td>pointer to buffer space for input </td></tr>
  501. </table>
  502. </dd>
  503. </dl>
  504. <dl class="section return"><dt>Returns</dt><dd>The function returns <code>ARM_MATH_SUCCESS</code></dd></dl>
  505. <p><b>Buffer size:</b></p>
  506. <p>vec_buffer size: 0</p>
  507. <p>Here we use only one pointer to read 4 rows in the weight matrix. So if the original matrix looks like this:</p>
  508. <p>| a11 | a12 | a13 |</p>
  509. <p>| a21 | a22 | a23 |</p>
  510. <p>| a31 | a32 | a33 |</p>
  511. <p>| a41 | a42 | a43 |</p>
  512. <p>| a51 | a52 | a53 |</p>
  513. <p>| a61 | a62 | a63 |</p>
  514. <p>We operates on multiple-of-4 rows, so the first four rows becomes</p>
  515. <p>| a11 | a12 | a21 | a22 | a31 | a32 | a41 | a42 |</p>
  516. <p>| a13 | a23 | a33 | a43 |</p>
  517. <p>Remaining rows are kept the same original order.</p>
  518. <p>So the stored weight matrix looks like this:</p>
  519. <p>| a11 | a12 | a21 | a22 | a31 | a32 | a41 | a42 |</p>
  520. <p>| a13 | a23 | a33 | a43 | a51 | a52 | a53 | a61 |</p>
  521. <p>| a62 | a63 | </p>
  522. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a4cbd428a2b4a4f6b2a6e4219520c7ce0">NN_ROUND</a>.</p>
  523. </div>
  524. </div>
  525. <a class="anchor" id="ga8b7e0c2e989e8c75f0dc789f3115323d"></a>
  526. <div class="memitem">
  527. <div class="memproto">
  528. <table class="memname">
  529. <tr>
  530. <td class="memname">arm_status arm_fully_connected_q7 </td>
  531. <td>(</td>
  532. <td class="paramtype">const q7_t *&#160;</td>
  533. <td class="paramname"><em>pV</em>, </td>
  534. </tr>
  535. <tr>
  536. <td class="paramkey"></td>
  537. <td></td>
  538. <td class="paramtype">const q7_t *&#160;</td>
  539. <td class="paramname"><em>pM</em>, </td>
  540. </tr>
  541. <tr>
  542. <td class="paramkey"></td>
  543. <td></td>
  544. <td class="paramtype">const uint16_t&#160;</td>
  545. <td class="paramname"><em>dim_vec</em>, </td>
  546. </tr>
  547. <tr>
  548. <td class="paramkey"></td>
  549. <td></td>
  550. <td class="paramtype">const uint16_t&#160;</td>
  551. <td class="paramname"><em>num_of_rows</em>, </td>
  552. </tr>
  553. <tr>
  554. <td class="paramkey"></td>
  555. <td></td>
  556. <td class="paramtype">const uint16_t&#160;</td>
  557. <td class="paramname"><em>bias_shift</em>, </td>
  558. </tr>
  559. <tr>
  560. <td class="paramkey"></td>
  561. <td></td>
  562. <td class="paramtype">const uint16_t&#160;</td>
  563. <td class="paramname"><em>out_shift</em>, </td>
  564. </tr>
  565. <tr>
  566. <td class="paramkey"></td>
  567. <td></td>
  568. <td class="paramtype">const q7_t *&#160;</td>
  569. <td class="paramname"><em>bias</em>, </td>
  570. </tr>
  571. <tr>
  572. <td class="paramkey"></td>
  573. <td></td>
  574. <td class="paramtype">q7_t *&#160;</td>
  575. <td class="paramname"><em>pOut</em>, </td>
  576. </tr>
  577. <tr>
  578. <td class="paramkey"></td>
  579. <td></td>
  580. <td class="paramtype">q15_t *&#160;</td>
  581. <td class="paramname"><em>vec_buffer</em>&#160;</td>
  582. </tr>
  583. <tr>
  584. <td></td>
  585. <td>)</td>
  586. <td></td><td></td>
  587. </tr>
  588. </table>
  589. </div><div class="memdoc">
  590. <dl class="params"><dt>Parameters</dt><dd>
  591. <table class="params">
  592. <tr><td class="paramdir">[in]</td><td class="paramname">pV</td><td>pointer to input vector </td></tr>
  593. <tr><td class="paramdir">[in]</td><td class="paramname">pM</td><td>pointer to matrix weights </td></tr>
  594. <tr><td class="paramdir">[in]</td><td class="paramname">dim_vec</td><td>length of the vector </td></tr>
  595. <tr><td class="paramdir">[in]</td><td class="paramname">num_of_rows</td><td>number of rows in weight matrix </td></tr>
  596. <tr><td class="paramdir">[in]</td><td class="paramname">bias_shift</td><td>amount of left-shift for bias </td></tr>
  597. <tr><td class="paramdir">[in]</td><td class="paramname">out_shift</td><td>amount of right-shift for output </td></tr>
  598. <tr><td class="paramdir">[in]</td><td class="paramname">bias</td><td>pointer to bias </td></tr>
  599. <tr><td class="paramdir">[in,out]</td><td class="paramname">pOut</td><td>pointer to output vector </td></tr>
  600. <tr><td class="paramdir">[in,out]</td><td class="paramname">vec_buffer</td><td>pointer to buffer space for input </td></tr>
  601. </table>
  602. </dd>
  603. </dl>
  604. <dl class="section return"><dt>Returns</dt><dd>The function returns <code>ARM_MATH_SUCCESS</code></dd></dl>
  605. <p><b>Buffer size:</b></p>
  606. <p>vec_buffer size: dim_vec</p>
  607. <p>This basic function is designed to work with regular weight matrix without interleaving. </p>
  608. <p>References <a class="el" href="group__nndata__convert.html#gaba8fd446d5f54760b406ee63b25d1aee">arm_q7_to_q15_reordered_no_shift()</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#a4cbd428a2b4a4f6b2a6e4219520c7ce0">NN_ROUND</a>.</p>
  609. </div>
  610. </div>
  611. <a class="anchor" id="gaf82b71ef472a38f8fc9ac414d9d07e67"></a>
  612. <div class="memitem">
  613. <div class="memproto">
  614. <table class="memname">
  615. <tr>
  616. <td class="memname">arm_status arm_fully_connected_q7_opt </td>
  617. <td>(</td>
  618. <td class="paramtype">const q7_t *&#160;</td>
  619. <td class="paramname"><em>pV</em>, </td>
  620. </tr>
  621. <tr>
  622. <td class="paramkey"></td>
  623. <td></td>
  624. <td class="paramtype">const q7_t *&#160;</td>
  625. <td class="paramname"><em>pM</em>, </td>
  626. </tr>
  627. <tr>
  628. <td class="paramkey"></td>
  629. <td></td>
  630. <td class="paramtype">const uint16_t&#160;</td>
  631. <td class="paramname"><em>dim_vec</em>, </td>
  632. </tr>
  633. <tr>
  634. <td class="paramkey"></td>
  635. <td></td>
  636. <td class="paramtype">const uint16_t&#160;</td>
  637. <td class="paramname"><em>num_of_rows</em>, </td>
  638. </tr>
  639. <tr>
  640. <td class="paramkey"></td>
  641. <td></td>
  642. <td class="paramtype">const uint16_t&#160;</td>
  643. <td class="paramname"><em>bias_shift</em>, </td>
  644. </tr>
  645. <tr>
  646. <td class="paramkey"></td>
  647. <td></td>
  648. <td class="paramtype">const uint16_t&#160;</td>
  649. <td class="paramname"><em>out_shift</em>, </td>
  650. </tr>
  651. <tr>
  652. <td class="paramkey"></td>
  653. <td></td>
  654. <td class="paramtype">const q7_t *&#160;</td>
  655. <td class="paramname"><em>bias</em>, </td>
  656. </tr>
  657. <tr>
  658. <td class="paramkey"></td>
  659. <td></td>
  660. <td class="paramtype">q7_t *&#160;</td>
  661. <td class="paramname"><em>pOut</em>, </td>
  662. </tr>
  663. <tr>
  664. <td class="paramkey"></td>
  665. <td></td>
  666. <td class="paramtype">q15_t *&#160;</td>
  667. <td class="paramname"><em>vec_buffer</em>&#160;</td>
  668. </tr>
  669. <tr>
  670. <td></td>
  671. <td>)</td>
  672. <td></td><td></td>
  673. </tr>
  674. </table>
  675. </div><div class="memdoc">
  676. <dl class="params"><dt>Parameters</dt><dd>
  677. <table class="params">
  678. <tr><td class="paramdir">[in]</td><td class="paramname">pV</td><td>pointer to input vector </td></tr>
  679. <tr><td class="paramdir">[in]</td><td class="paramname">pM</td><td>pointer to matrix weights </td></tr>
  680. <tr><td class="paramdir">[in]</td><td class="paramname">dim_vec</td><td>length of the vector </td></tr>
  681. <tr><td class="paramdir">[in]</td><td class="paramname">num_of_rows</td><td>number of rows in weight matrix </td></tr>
  682. <tr><td class="paramdir">[in]</td><td class="paramname">bias_shift</td><td>amount of left-shift for bias </td></tr>
  683. <tr><td class="paramdir">[in]</td><td class="paramname">out_shift</td><td>amount of right-shift for output </td></tr>
  684. <tr><td class="paramdir">[in]</td><td class="paramname">bias</td><td>pointer to bias </td></tr>
  685. <tr><td class="paramdir">[in,out]</td><td class="paramname">pOut</td><td>pointer to output vector </td></tr>
  686. <tr><td class="paramdir">[in,out]</td><td class="paramname">vec_buffer</td><td>pointer to buffer space for input </td></tr>
  687. </table>
  688. </dd>
  689. </dl>
  690. <dl class="section return"><dt>Returns</dt><dd>The function returns <code>ARM_MATH_SUCCESS</code></dd></dl>
  691. <p><b>Buffer size:</b></p>
  692. <p>vec_buffer size: dim_vec</p>
  693. <p>This opt function is designed to work with interleaved weight matrix. The vector input is assumed in q7_t format, we call arm_q7_to_q15_no_shift_shuffle function to expand into q15_t format with certain weight re-ordering, refer to the function comments for more details. Here we use only one pointer to read 4 rows in the weight matrix. So if the original q7_t matrix looks like this:</p>
  694. <p>| a11 | a12 | a13 | a14 | a15 | a16 | a17 |</p>
  695. <p>| a21 | a22 | a23 | a24 | a25 | a26 | a27 |</p>
  696. <p>| a31 | a32 | a33 | a34 | a35 | a36 | a37 |</p>
  697. <p>| a41 | a42 | a43 | a44 | a45 | a46 | a47 |</p>
  698. <p>| a51 | a52 | a53 | a54 | a55 | a56 | a57 |</p>
  699. <p>| a61 | a62 | a63 | a64 | a65 | a66 | a67 |</p>
  700. <p>We operates on multiple-of-4 rows, so the first four rows becomes</p>
  701. <p>| a11 | a21 | a13 | a23 | a31 | a41 | a33 | a43 |</p>
  702. <p>| a12 | a22 | a14 | a24 | a32 | a42 | a34 | a44 |</p>
  703. <p>| a15 | a25 | a35 | a45 | a16 | a26 | a36 | a46 |</p>
  704. <p>So within the kernel, we first read the re-ordered vector in as:</p>
  705. <p>| b1 | b3 | and | b2 | b4 |</p>
  706. <p>the four q31_t weights will look like</p>
  707. <p>| a11 | a13 |, | a21 | a23 |, | a31 | a33 |, | a41 | a43 |</p>
  708. <p>| a12 | a14 |, | a22 | a24 |, | a32 | a34 |, | a42 | a44 |</p>
  709. <p>The column left over will be in-order. which is:</p>
  710. <p>| a17 | a27 | a37 | a47 |</p>
  711. <p>For the left-over rows, we do 1x1 computation, so the data remains as its original order.</p>
  712. <p>So the stored weight matrix looks like this:</p>
  713. <p>| a11 | a21 | a13 | a23 | a31 | a41 |</p>
  714. <p>| a33 | a43 | a12 | a22 | a14 | a24 |</p>
  715. <p>| a32 | a42 | a34 | a44 | a15 | a25 |</p>
  716. <p>| a35 | a45 | a16 | a26 | a36 | a46 |</p>
  717. <p>| a17 | a27 | a37 | a47 | a51 | a52 |</p>
  718. <p>| a53 | a54 | a55 | a56 | a57 | a61 |</p>
  719. <p>| a62 | a63 | a64 | a65 | a66 | a67 | </p>
  720. <p>References <a class="el" href="group__nndata__convert.html#gaba8fd446d5f54760b406ee63b25d1aee">arm_q7_to_q15_reordered_no_shift()</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#a4cbd428a2b4a4f6b2a6e4219520c7ce0">NN_ROUND</a>.</p>
  721. <p>Referenced by <a class="el" href="arm__nnexamples__cifar10_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>
  722. </div>
  723. </div>
  724. </div><!-- contents -->
  725. </div><!-- doc-content -->
  726. <!-- start footer part -->
  727. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  728. <ul>
  729. <li class="footer">Generated on Wed Jul 10 2019 15:20:50 for CMSIS-NN Version 1.2.0 by Arm Ltd. All rights reserved.
  730. <!--
  731. <a href="http://www.doxygen.org/index.html">
  732. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  733. -->
  734. </li>
  735. </ul>
  736. </div>
  737. </body>
  738. </html>