]> begriffs open source - cmsis/blob - main/NN/index.html
Update documentation for branch main
[cmsis] / main / NN / index.html
1 <!-- HTML header for doxygen 1.9.6-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>CMSIS-NN: CMSIS-NN</title>
9 <link href="doxygen.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="tabs.js"></script>
13 <script type="text/javascript" src="footer.js"></script>
14 <script type="text/javascript" src="navtree.js"></script>
15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
16 <script type="text/javascript" src="resize.js"></script>
17 <script type="text/javascript" src="navtreedata.js"></script>
18 <script type="text/javascript" src="navtree.js"></script>
19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="search/searchdata.js"></script>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
24   $(document).ready(function() { init_search(); });
25 /* @license-end */
26 </script>
27 <script type="text/javascript" src="darkmode_toggle.js"></script>
28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
32 <link href="version.css" rel="stylesheet" type="text/css"/>
33 <script type="text/javascript" src="../../version.js"></script>
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 55px;">
41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
43    <div id="projectname">CMSIS-NN
44    </div>
45    <div id="projectbrief">CMSIS NN Software Library</div>
46   </td>
47    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
48         <span class="left">
49           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
50           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
51                onfocus="searchBox.OnSearchFieldFocus(true)" 
52                onblur="searchBox.OnSearchFieldFocus(false)" 
53                onkeyup="searchBox.OnSearchFieldChange(event)"/>
54           </span><span class="right">
55             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
56           </span>
57         </div>
58 </td>
59   <!--END !PROJECT_NAME-->
60  </tr>
61  </tbody>
62 </table>
63 </div>
64 <!-- end header part -->
65 <div id="CMSISnav" class="tabs1">
66   <ul class="tablist">
67     <script type="text/javascript">
68       writeComponentTabs.call(this);
69     </script>
70   </ul>
71 </div>
72 <script type="text/javascript">
73   writeSubComponentTabs.call(this);
74 </script>
75 <!-- Generated by Doxygen 1.9.6 -->
76 <script type="text/javascript">
77 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
78 var searchBox = new SearchBox("searchBox", "search/",'.html');
79 /* @license-end */
80 </script>
81 </div><!-- top -->
82 <div id="side-nav" class="ui-resizable side-nav-resizable">
83   <div id="nav-tree">
84     <div id="nav-tree-contents">
85       <div id="nav-sync" class="sync"></div>
86     </div>
87   </div>
88   <div id="splitbar" style="-moz-user-select:none;" 
89        class="ui-resizable-handle">
90   </div>
91 </div>
92 <script type="text/javascript">
93 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
94 $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
95 /* @license-end */
96 </script>
97 <div id="doc-content">
98 <!-- window showing the filter options -->
99 <div id="MSearchSelectWindow"
100      onmouseover="return searchBox.OnSearchSelectShow()"
101      onmouseout="return searchBox.OnSearchSelectHide()"
102      onkeydown="return searchBox.OnSearchSelectKey(event)">
103 </div>
104
105 <!-- iframe showing the search results (closed by default) -->
106 <div id="MSearchResultsWindow">
107 <div id="MSearchResults">
108 <div class="SRPage">
109 <div id="SRIndex">
110 <div id="SRResults"></div>
111 <div class="SRStatus" id="Loading">Loading...</div>
112 <div class="SRStatus" id="Searching">Searching...</div>
113 <div class="SRStatus" id="NoMatches">No Matches</div>
114 </div>
115 </div>
116 </div>
117 </div>
118
119 <div><div class="header">
120   <div class="headertitle"><div class="title">CMSIS-NN </div></div>
121 </div><!--header-->
122 <div class="contents">
123 <div class="textblock"><p><a class="anchor" id="mainpage"></a> <b>CMSIS-NN</b> is an open-source software library that provides a collection of efficient neural network (NN) kernels developed to maximize the performance and minimize the memory footprint of neural networks running on Arm Cortex-M processors.</p>
124 <div class="image">
125 <img src="cmsis-nn-overview.png" alt=""/>
126 <div class="caption">
127 Overview of CMSIS-NN</div></div>
128     <p>CMSIS-NN functions are implemented in several variants and the optimal solution is automatically taken at compile time depending on the features available on the target processor architecture. Implementations for the following features are available:</p>
129 <ul>
130 <li>Single Instruction Multiple Data (SIMD) capability (e.g, Cortex-M0)</li>
131 <li>DSP extension (e.g Cortex-M4)</li>
132 <li>Arm M-Profile Vector Extension(MVE) (e.g Cortex-M55).</li>
133 </ul>
134 <h1><a class="anchor" id="autotoc_md0"></a>
135 Access to CMSIS-NN</h1>
136 <p>CMSIS-NN is actively maintained in a GitHub repository and is released as a standalone package in CMSIS-Pack format.</p>
137 <ul>
138 <li><a href="https://github.com/ARM-software/CMSIS-NN"><b>CMSIS-NN GitHub Repo</b></a> provides the full source code of CMSIS-NN kernels.</li>
139 <li><a href="https://arm-software.github.io/CMSIS-NN/latest/"><b>CMSIS-NN Documentation</b></a> explains how to use the library and describes the implemented functions in details.</li>
140 <li><a href="https://www.keil.arm.com/packs/cmsis-nn-arm/versions/"><b>CMSIS-NN Pack</b></a> delivers CMSIS-NN components and examples in <a href="https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html">CMSIS-Pack format</a>.</li>
141 </ul>
142 <h1><a class="anchor" id="autotoc_md1"></a>
143 Key Features and Benefits</h1>
144 <ul>
145 <li>CMSIS-NN provides a broad set of neural network kernels for Cortex-M devices.</li>
146 <li>Optimized implementations for different Cortex-M capabilities (SIMD, FPU, MVE).</li>
147 <li>Arm Compiler 6 and on Arm GNU Toolchain support.</li>
148 <li>Follows int8 and int16 quantization specification of TensorFlow Lite for Microcontrollers.</li>
149 <li>Widely adopted in the industry. </li>
150 </ul>
151 </div></div><!-- PageDoc -->
152 </div><!-- contents -->
153 </div><!-- doc-content -->
154 <!-- start footer part -->
155 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
156   <ul>
157     <li class="footer">
158       <script type="text/javascript">
159         <!--
160         writeFooter.call(this);
161         //-->
162       </script> 
163     </li>
164   </ul>
165 </div>
166 </body>
167 </html>