163 lines
		
	
	
		
			8.6 KiB
		
	
	
	
		
			HTML
		
	
	
	
			
		
		
	
	
			163 lines
		
	
	
		
			8.6 KiB
		
	
	
	
		
			HTML
		
	
	
	
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 | |
| <html xmlns="http://www.w3.org/1999/xhtml">
 | |
| <head>
 | |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 | |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 | |
| <title>Gated Recurrent Unit Example</title>
 | |
| <title>CMSIS-NN: Gated Recurrent Unit Example</title>
 | |
| <link href="tabs.css" rel="stylesheet" type="text/css"/>
 | |
| <link href="cmsis.css" rel="stylesheet" type="text/css" />
 | |
| <script type="text/javascript" src="jquery.js"></script>
 | |
| <script type="text/javascript" src="dynsections.js"></script>
 | |
| <script type="text/javascript" src="printComponentTabs.js"></script>
 | |
| <link href="navtree.css" rel="stylesheet" type="text/css"/>
 | |
| <script type="text/javascript" src="resize.js"></script>
 | |
| <script type="text/javascript" src="navtree.js"></script>
 | |
| <script type="text/javascript">
 | |
|   $(document).ready(initResizable);
 | |
|   $(window).load(resizeHeight);
 | |
| </script>
 | |
| <link href="search/search.css" rel="stylesheet" type="text/css"/>
 | |
| <script type="text/javascript" src="search/search.js"></script>
 | |
| <script type="text/javascript">
 | |
|   $(document).ready(function() { searchBox.OnSelectItem(0); });
 | |
| </script>
 | |
| </head>
 | |
| <body>
 | |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 | |
| <div id="titlearea">
 | |
| <table cellspacing="0" cellpadding="0">
 | |
|  <tbody>
 | |
|  <tr style="height: 46px;">
 | |
|   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
 | |
|   <td style="padding-left: 0.5em;">
 | |
|    <div id="projectname">CMSIS-NN
 | |
|     <span id="projectnumber">Version 1.1.0</span>
 | |
|    </div>
 | |
|    <div id="projectbrief">CMSIS NN Software Library</div>
 | |
|   </td>
 | |
|  </tr>
 | |
|  </tbody>
 | |
| </table>
 | |
| </div>
 | |
| <!-- end header part -->
 | |
| <div id="CMSISnav" class="tabs1">
 | |
|     <ul class="tablist">
 | |
|       <script type="text/javascript">
 | |
| 		<!--
 | |
| 		writeComponentTabs.call(this);
 | |
| 		//-->
 | |
|       </script>
 | |
| 	  </ul>
 | |
| </div>
 | |
| <!-- Generated by Doxygen 1.8.6 -->
 | |
| <script type="text/javascript">
 | |
| var searchBox = new SearchBox("searchBox", "search",false,'Search');
 | |
| </script>
 | |
|   <div id="navrow1" class="tabs">
 | |
|     <ul class="tablist">
 | |
|       <li><a href="index.html"><span>Main Page</span></a></li>
 | |
|       <li><a href="pages.html"><span>Usage and Description</span></a></li>
 | |
|       <li><a href="modules.html"><span>Reference</span></a></li>
 | |
|       <li>
 | |
|         <div id="MSearchBox" class="MSearchBoxInactive">
 | |
|         <span class="left">
 | |
|           <img id="MSearchSelect" src="search/mag_sel.png"
 | |
|                onmouseover="return searchBox.OnSearchSelectShow()"
 | |
|                onmouseout="return searchBox.OnSearchSelectHide()"
 | |
|                alt=""/>
 | |
|           <input type="text" id="MSearchField" value="Search" accesskey="S"
 | |
|                onfocus="searchBox.OnSearchFieldFocus(true)" 
 | |
|                onblur="searchBox.OnSearchFieldFocus(false)" 
 | |
|                onkeyup="searchBox.OnSearchFieldChange(event)"/>
 | |
|           </span><span class="right">
 | |
|             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
 | |
|           </span>
 | |
|         </div>
 | |
|       </li>
 | |
|     </ul>
 | |
|   </div>
 | |
| </div><!-- top -->
 | |
| <div id="side-nav" class="ui-resizable side-nav-resizable">
 | |
|   <div id="nav-tree">
 | |
|     <div id="nav-tree-contents">
 | |
|       <div id="nav-sync" class="sync"></div>
 | |
|     </div>
 | |
|   </div>
 | |
|   <div id="splitbar" style="-moz-user-select:none;" 
 | |
|        class="ui-resizable-handle">
 | |
|   </div>
 | |
| </div>
 | |
| <script type="text/javascript">
 | |
| $(document).ready(function(){initNavTree('group__GRUExample.html','');});
 | |
| </script>
 | |
| <div id="doc-content">
 | |
| <!-- window showing the filter options -->
 | |
| <div id="MSearchSelectWindow"
 | |
|      onmouseover="return searchBox.OnSearchSelectShow()"
 | |
|      onmouseout="return searchBox.OnSearchSelectHide()"
 | |
|      onkeydown="return searchBox.OnSearchSelectKey(event)">
 | |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
 | |
| 
 | |
| <!-- iframe showing the search results (closed by default) -->
 | |
| <div id="MSearchResultsWindow">
 | |
| <iframe src="javascript:void(0)" frameborder="0" 
 | |
|         name="MSearchResults" id="MSearchResults">
 | |
| </iframe>
 | |
| </div>
 | |
| 
 | |
| <div class="header">
 | |
|   <div class="headertitle">
 | |
| <div class="title">Gated Recurrent Unit Example</div>  </div>
 | |
| </div><!--header-->
 | |
| <div class="contents">
 | |
| <dl class="section user"><dt>Description:</dt><dd></dd></dl>
 | |
| <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>
 | |
| <dl class="section user"><dt>Model definition:</dt><dd></dd></dl>
 | |
| <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>
 | |
| <dl class="section user"><dt></dt><dd>The computation can be summarized as: <pre>z[t] = sigmoid( W_z ⋅ {h[t-1],x[t]} )
 | |
| r[t] = sigmoid( W_r ⋅ {h[t-1],x[t]} ) 
 | |
| n[t] = tanh( W_n ⋅ [r[t] × {h[t-1], x[t]} ) 
 | |
| h[t] = (1 - z[t]) × h[t-1] + z[t] × n[t] </pre> <div class="image">
 | |
| <img src="GRU.gif" alt="GRU.gif"/>
 | |
| <div class="caption">
 | |
| Gate Recurrent Unit Diagram</div></div>
 | |
|  </dd></dl>
 | |
| <dl class="section user"><dt>Variables Description:</dt><dd></dd></dl>
 | |
| <dl class="section user"><dt></dt><dd><ul>
 | |
| <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>
 | |
| <li><code>update_gate_bias</code>, <code>reset_gate_bias</code>, <code>hidden_state_bias</code> are layer bias arrays </li>
 | |
| <li><code>test_input1</code>, <code>test_input2</code>, <code>test_history</code> are the inputs and initial history</li>
 | |
| </ul>
 | |
| </dd></dl>
 | |
| <dl class="section user"><dt></dt><dd>The buffer is allocated as: </dd></dl>
 | |
| <dl class="section user"><dt></dt><dd>| reset | input | history | update | hidden_state | </dd></dl>
 | |
| <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>
 | |
| <dl class="section user"><dt></dt><dd>The ordering of the weight matrix should be adjusted accordingly.</dd></dl>
 | |
| <dl class="section user"><dt>CMSIS DSP Software Library Functions Used:</dt><dd></dd></dl>
 | |
| <dl class="section user"><dt></dt><dd><ul>
 | |
| <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>
 | |
| <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>
 | |
| <li>arm_mult_q15()</li>
 | |
| <li>arm_offset_q15()</li>
 | |
| <li>arm_sub_q15()</li>
 | |
| <li>arm_copy_q15()</li>
 | |
| </ul>
 | |
| </dd></dl>
 | |
| <p><b> Refer </b> <a class="el" href="arm__nnexamples__gru_8cpp.html">arm_nnexamples_gru.cpp</a> </p>
 | |
| </div><!-- contents -->
 | |
| </div><!-- doc-content -->
 | |
| <!-- start footer part -->
 | |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 | |
|   <ul>
 | |
|     <li class="footer">Generated on Wed Aug 1 2018 17:12:32 for CMSIS-NN by Arm Ltd. All rights reserved.
 | |
| 	<!--
 | |
|     <a href="http://www.doxygen.org/index.html">
 | |
|     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
 | |
| 	-->
 | |
| 	</li>
 | |
|   </ul>
 | |
| </div>
 | |
| </body>
 | |
| </html>
 |