group__GRUExample.html 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  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>Gated Recurrent Unit Example</title>
  7. <title>CMSIS-NN: Gated Recurrent Unit Example</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__GRUExample.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="headertitle">
  109. <div class="title">Gated Recurrent Unit Example</div> </div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <dl class="section user"><dt>Description:</dt><dd></dd></dl>
  113. <dl class="section user"><dt></dt><dd>Demonstrates a gated recurrent unit (GRU) example with the use of fully-connected, Tanh/Sigmoid activation functions.</dd></dl>
  114. <dl class="section user"><dt>Model definition:</dt><dd></dd></dl>
  115. <dl class="section user"><dt></dt><dd>GRU is a type of recurrent neural network (RNN). It contains two sigmoid gates and one hidden state. </dd></dl>
  116. <dl class="section user"><dt></dt><dd>The computation can be summarized as: <pre>z[t] = sigmoid( W_z &sdot; {h[t-1],x[t]} )
  117. r[t] = sigmoid( W_r &sdot; {h[t-1],x[t]} )
  118. n[t] = tanh( W_n &sdot; [r[t] &times; {h[t-1], x[t]} )
  119. h[t] = (1 - z[t]) &times; h[t-1] + z[t] &times; n[t] </pre> <div class="image">
  120. <img src="GRU.gif" alt="GRU.gif"/>
  121. <div class="caption">
  122. Gate Recurrent Unit Diagram</div></div>
  123. </dd></dl>
  124. <dl class="section user"><dt>Variables Description:</dt><dd></dd></dl>
  125. <dl class="section user"><dt></dt><dd><ul>
  126. <li><code>update_gate_weights</code>, <code>reset_gate_weights</code>, <code>hidden_state_weights</code> are weights corresponding to update gate (W_z), reset gate (W_r), and hidden state (W_n). </li>
  127. <li><code>update_gate_bias</code>, <code>reset_gate_bias</code>, <code>hidden_state_bias</code> are layer bias arrays </li>
  128. <li><code>test_input1</code>, <code>test_input2</code>, <code>test_history</code> are the inputs and initial history</li>
  129. </ul>
  130. </dd></dl>
  131. <dl class="section user"><dt></dt><dd>The buffer is allocated as: </dd></dl>
  132. <dl class="section user"><dt></dt><dd>| reset | input | history | update | hidden_state | </dd></dl>
  133. <dl class="section user"><dt></dt><dd>In this way, the concatination is automatically done since (reset, input) and (input, history) are physically concatinated in memory. </dd></dl>
  134. <dl class="section user"><dt></dt><dd>The ordering of the weight matrix should be adjusted accordingly.</dd></dl>
  135. <dl class="section user"><dt>CMSIS DSP Software Library Functions Used:</dt><dd></dd></dl>
  136. <dl class="section user"><dt></dt><dd><ul>
  137. <li><a class="el" href="group__FC.html#gae3857bb6375692e81dde8cbd70adec08" title="Mixed Q15-Q7 opt fully-connected layer function. ">arm_fully_connected_mat_q7_vec_q15_opt()</a></li>
  138. <li><a class="el" href="group__Acti.html#ga8932b57c8d0ee757511af2d40dcc11e7" title="Q15 neural network activation function using direct table look-up. ">arm_nn_activations_direct_q15()</a></li>
  139. <li>arm_mult_q15()</li>
  140. <li>arm_offset_q15()</li>
  141. <li>arm_sub_q15()</li>
  142. <li>arm_copy_q15()</li>
  143. </ul>
  144. </dd></dl>
  145. <p><b> Refer </b> <a class="el" href="arm__nnexamples__gru_8cpp.html">arm_nnexamples_gru.cpp</a> </p>
  146. </div><!-- contents -->
  147. </div><!-- doc-content -->
  148. <!-- start footer part -->
  149. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  150. <ul>
  151. <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.
  152. <!--
  153. <a href="http://www.doxygen.org/index.html">
  154. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  155. -->
  156. </li>
  157. </ul>
  158. </div>
  159. </body>
  160. </html>