| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352 |
- <!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>Activation Functions</title>
- <title>CMSIS-NN: Activation Functions</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.3.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__Acti.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="summary">
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">Activation Functions<div class="ingroups"><a class="el" href="group__groupNN.html">Neural Network Functions</a></div></div> </div>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:ga8932b57c8d0ee757511af2d40dcc11e7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Acti.html#ga8932b57c8d0ee757511af2d40dcc11e7">arm_nn_activations_direct_q15</a> (q15_t *data, uint16_t size, uint16_t int_width, <a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0">arm_nn_activation_type</a> type)</td></tr>
- <tr class="memdesc:ga8932b57c8d0ee757511af2d40dcc11e7"><td class="mdescLeft"> </td><td class="mdescRight">neural network activation function using direct table look-up <a href="#ga8932b57c8d0ee757511af2d40dcc11e7">More...</a><br/></td></tr>
- <tr class="separator:ga8932b57c8d0ee757511af2d40dcc11e7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga79f11131ae6767d60e03b1f6506b1af8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Acti.html#ga79f11131ae6767d60e03b1f6506b1af8">arm_nn_activations_direct_q7</a> (q7_t *data, uint16_t size, uint16_t int_width, <a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0">arm_nn_activation_type</a> type)</td></tr>
- <tr class="memdesc:ga79f11131ae6767d60e03b1f6506b1af8"><td class="mdescLeft"> </td><td class="mdescRight">Q7 neural network activation function using direct table look-up. <a href="#ga79f11131ae6767d60e03b1f6506b1af8">More...</a><br/></td></tr>
- <tr class="separator:ga79f11131ae6767d60e03b1f6506b1af8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga01a7a7c17f0cd544e29c4752daeecdc3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Acti.html#ga01a7a7c17f0cd544e29c4752daeecdc3">arm_relu6_s8</a> (q7_t *data, uint16_t size)</td></tr>
- <tr class="memdesc:ga01a7a7c17f0cd544e29c4752daeecdc3"><td class="mdescLeft"> </td><td class="mdescRight">s8 ReLU6 function <a href="#ga01a7a7c17f0cd544e29c4752daeecdc3">More...</a><br/></td></tr>
- <tr class="separator:ga01a7a7c17f0cd544e29c4752daeecdc3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga53bcc00e54b802919bb3c89c143ee5ba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Acti.html#ga53bcc00e54b802919bb3c89c143ee5ba">arm_relu_q15</a> (q15_t *data, uint16_t size)</td></tr>
- <tr class="memdesc:ga53bcc00e54b802919bb3c89c143ee5ba"><td class="mdescLeft"> </td><td class="mdescRight">Q15 RELU function. <a href="#ga53bcc00e54b802919bb3c89c143ee5ba">More...</a><br/></td></tr>
- <tr class="separator:ga53bcc00e54b802919bb3c89c143ee5ba"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga638e803b4fe00426f401783a6255ca30"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Acti.html#ga638e803b4fe00426f401783a6255ca30">arm_relu_q7</a> (q7_t *data, uint16_t size)</td></tr>
- <tr class="memdesc:ga638e803b4fe00426f401783a6255ca30"><td class="mdescLeft"> </td><td class="mdescRight">Q7 RELU function. <a href="#ga638e803b4fe00426f401783a6255ca30">More...</a><br/></td></tr>
- <tr class="separator:ga638e803b4fe00426f401783a6255ca30"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
- <p>Perform activation layers, including ReLU (Rectified Linear Unit), sigmoid and tanh </p>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="ga8932b57c8d0ee757511af2d40dcc11e7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void arm_nn_activations_direct_q15 </td>
- <td>(</td>
- <td class="paramtype">q15_t * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint16_t </td>
- <td class="paramname"><em>size</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint16_t </td>
- <td class="paramname"><em>int_width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0">arm_nn_activation_type</a> </td>
- <td class="paramname"><em>type</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Q15 neural network activation function using direct table look-up.</p>
- <dl class="section note"><dt>Note</dt><dd>Refer header file for details. </dd></dl>
- <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0a49b307e029715fbaa6f3101c806b8c54">ARM_SIGMOID</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0ac24e4db95c986f16c10dca71a4b4e1c5">ARM_TANH</a>, <a class="el" href="arm__nn__tables_8h.html#ab4d7b07c387a3537d4efe21da86115b0">sigmoidTable_q15</a>, and <a class="el" href="arm__nn__tables_8h.html#a6faad2fec173b2702fd0f219a83ca320">tanhTable_q15</a>.</p>
- <p>Referenced by <a class="el" href="arm__nnexamples__gru_8cpp.html#ac71a806472c7c0c284a2253e71a6a27b">gru_example()</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ga79f11131ae6767d60e03b1f6506b1af8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void arm_nn_activations_direct_q7 </td>
- <td>(</td>
- <td class="paramtype">q7_t * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint16_t </td>
- <td class="paramname"><em>size</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint16_t </td>
- <td class="paramname"><em>int_width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0">arm_nn_activation_type</a> </td>
- <td class="paramname"><em>type</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>pointer to input </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>number of elements </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">int_width</td><td>bit-width of the integer part, assume to be smaller than 3 </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>type of activation functions</td></tr>
- </table>
- </dd>
- </dl>
- <p>This is the direct table look-up approach.</p>
- <p>Assume here the integer part of the fixed-point is <= 3. More than 3 just not making much sense, makes no difference with saturation followed by any of these activation functions. </p>
- <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0a49b307e029715fbaa6f3101c806b8c54">ARM_SIGMOID</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a7f41aa78cd9a0552fae9b348ee4831a0ac24e4db95c986f16c10dca71a4b4e1c5">ARM_TANH</a>, <a class="el" href="arm__nn__tables_8h.html#ae2ff3f4e7014f535358167150bdd544f">sigmoidTable_q7</a>, and <a class="el" href="arm__nn__tables_8h.html#a4f854bdf13f630ec21b3ad074491e32f">tanhTable_q7</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ga01a7a7c17f0cd544e29c4752daeecdc3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void arm_relu6_s8 </td>
- <td>(</td>
- <td class="paramtype">q7_t * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint16_t </td>
- <td class="paramname"><em>size</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>pointer to input </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>number of elements </td></tr>
- </table>
- </dd>
- </dl>
- <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#adcd021ac91d43a62b2cdecf9a5b971a7">MIN</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ga53bcc00e54b802919bb3c89c143ee5ba"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void arm_relu_q15 </td>
- <td>(</td>
- <td class="paramtype">q15_t * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint16_t </td>
- <td class="paramname"><em>size</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>pointer to input </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>number of elements</td></tr>
- </table>
- </dd>
- </dl>
- <p>Optimized relu with QSUB instructions. </p>
- </div>
- </div>
- <a class="anchor" id="ga638e803b4fe00426f401783a6255ca30"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void arm_relu_q7 </td>
- <td>(</td>
- <td class="paramtype">q7_t * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint16_t </td>
- <td class="paramname"><em>size</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>pointer to input </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>number of elements</td></tr>
- </table>
- </dd>
- </dl>
- <p>Optimized relu with QSUB instructions. </p>
- <p>Referenced by <a class="el" href="arm__nnexamples__cifar10_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>
- </div>
- </div>
- </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 Thu Apr 9 2020 15:49:34 for CMSIS-NN Version 1.3.0 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>
|