aboutsummaryrefslogtreecommitdiff
path: root/23.02/index.xhtml
diff options
context:
space:
mode:
authorDavid Monahan <david.monahan@arm.com>2023-03-22 16:48:58 +0000
committerDavid Monahan <david.monahan@arm.com>2023-03-22 16:48:58 +0000
commitae050524109f1ce827962665436ef7430f2ac479 (patch)
treea087fe0c77570971dd7979f2757426c24e91afc7 /23.02/index.xhtml
parent8d2ca734165a068478df7cffa46185680b05cd20 (diff)
downloadarmnn-ae050524109f1ce827962665436ef7430f2ac479.tar.gz
IVGCVSW-7255 Update Doxygen Documentation and publish on GitHub.
* Updating Doxygen documentation for 23.02 release. Signed-off-by: David Monahan <david.monahan@arm.com> Change-Id: I545574ff7664b4595d2fe6a91a3c35d2ad55df82
Diffstat (limited to '23.02/index.xhtml')
-rw-r--r--23.02/index.xhtml135
1 files changed, 68 insertions, 67 deletions
diff --git a/23.02/index.xhtml b/23.02/index.xhtml
index 37ebc35d8d..2c89ae0a1a 100644
--- a/23.02/index.xhtml
+++ b/23.02/index.xhtml
@@ -8,7 +8,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmNN: Main Page</title>
@@ -19,9 +19,6 @@
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
-<script type="text/javascript">
- $(document).ready(initResizable);
-</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
@@ -30,7 +27,8 @@
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
-</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
+</script>
+<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
@@ -51,18 +49,21 @@
</table>
</div>
<!-- end header part -->
-<!-- Generated by Doxygen 1.8.13 -->
+<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
-</script>
+/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -76,7 +77,9 @@ $(function() {
</div>
</div>
<script type="text/javascript">
-$(document).ready(function(){initNavTree('index.xhtml','');});
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('index.xhtml',''); initResizable(); });
+/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
@@ -93,16 +96,13 @@ $(document).ready(function(){initNavTree('index.xhtml','');});
</iframe>
</div>
-<div class="header">
+<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">ArmNN Documentation</div> </div>
</div><!--header-->
<div class="contents">
-<div class="textblock"><p><br />
- </p><div align="center"> <div class="image">
-<img src="Arm_NN_horizontal_blue.png" class="center" alt="Arm NN Logo" width="300"/>
-</div>
- </div><ul>
+<div class="textblock"><p><br />
+ </p><div align="center"> <img src="Arm_NN_horizontal_blue.png" alt="Arm NN Logo" class="center" width="300" class="inline"/> </div><ul>
<li><a href="#quick-start-guides">Quick Start Guides</a></li>
<li><a href="#pre-built-binaries">Pre-Built Binaries</a></li>
<li><a href="#software-overview">Software Overview</a></li>
@@ -121,24 +121,24 @@ $(document).ready(function(){initNavTree('index.xhtml','');});
<p><b>The Arm NN TF Lite Delegate provides the widest ML operator support in Arm NN</b> and is an easy way to accelerate your ML model. To start using the TF Lite Delegate, first download the <b><a href="#pre-built-binaries">Pre-Built Binaries</a></b> for the latest release of Arm NN. Using a Python interpreter, you can load your TF Lite model into the Arm NN TF Lite Delegate and run accelerated inference. Please see this <b><a class="el" href="md_delegate__delegate_quick_start_guide.xhtml">Quick Start Guide</a></b> on GitHub or this more comprehensive <b><a href="https://developer.arm.com/documentation/102561/latest/">Arm Developer Guide</a></b> for information on how to accelerate your TF Lite model using the Arm NN TF Lite Delegate.</p>
<p>The fastest way to integrate Arm NN into an <b>Android app</b> is by using our <b>Arm NN AAR (Android Archive) file with Android Studio</b>. The AAR file nicely packages up the Arm NN TF Lite Delegate, Arm NN itself and ACL; ready to be integrated into your Android ML application. Using the AAR allows you to benefit from the <b>vast operator support</b> of the Arm NN TF Lite Delegate. We held an <b><a href="https://www.youtube.com/watch?v=Zu4v0nqq2FA">Arm AI Tech Talk</a></b> on how to accelerate an ML Image Segmentation app in 5 minutes using this AAR file. To download the Arm NN AAR file, please see the <b><a href="#pre-built-binaries">Pre-Built Binaries</a></b> section below.</p>
<p>We also provide Debian packages for Arm NN, which are a quick way to start using Arm NN and the TF Lite Parser (albeit with less ML operator support than the TF Lite Delegate). There is an installation guide available <a class="el" href="md__installation_via_apt_repository.xhtml">here</a> which provides instructions on how to install the Arm NN Core and the TF Lite Parser for Ubuntu 20.04.</p>
-<p>To build Arm NN from scratch, we provide the <b>Arm NN Build Tool</b>. This tool consists of <b>parameterized bash scripts</b> accompanied by a <b>Dockerfile</b> for building Arm NN and its dependencies, including <b><a href="https://github.com/ARM-software/ComputeLibrary/">Arm Compute Library (ACL)</a></b>. This tool replaces/supersedes the majority of the existing Arm NN build guides as a user-friendly way to build Arm NN. The main benefit of building Arm NN from scratch is the ability to <b>exactly choose which components to build, targeted for your ML project</b>.<br />
+<p>To build Arm NN from scratch, we provide the <b>Arm NN Build Tool</b>. This tool consists of <b>parameterized bash scripts</b> accompanied by a <b>Dockerfile</b> for building Arm NN and its dependencies, including <b><a href="https://github.com/ARM-software/ComputeLibrary/">Arm Compute Library (ACL)</a></b>. This tool replaces/supersedes the majority of the existing Arm NN build guides as a user-friendly way to build Arm NN. The main benefit of building Arm NN from scratch is the ability to <b>exactly choose which components to build, targeted for your ML project</b>.<br />
</p>
<h2>Pre-Built Binaries</h2>
-<table class="doxtable">
-<tr>
-<th>Operating System </th><th>Architecture-specific Release Archive (Download) </th></tr>
-<tr>
-<td>Android (AAR) </td><td><a href="https://github.com/ARM-software/armnn/releases/download/v23.02/armnn_delegate_jni-23.02.aar"></a> </td></tr>
-<tr>
-<td>Android 10 "Q/Quince Tart" (API level 29) </td><td><a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-29-arm64-v8.2-a.tar.gz"></a> <a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-29-arm64-v8a.tar.gz"></a> </td></tr>
-<tr>
-<td>Android 11 "R/Red Velvet Cake" (API level 30) </td><td><a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-30-arm64-v8.2-a.tar.gz"></a> <a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-30-arm64-v8a.tar.gz"></a> </td></tr>
-<tr>
-<td>Android 12 "S/Snow Cone" (API level 31) </td><td><a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-31-arm64-v8.2-a.tar.gz"></a> <a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-31-arm64-v8a.tar.gz"></a> </td></tr>
-<tr>
-<td>Android 13 "T/Tiramisu" (API level 32) </td><td><a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-32-arm64-v8.2-a.tar.gz"></a> <a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-32-arm64-v8a.tar.gz"></a> </td></tr>
-<tr>
-<td>Linux </td><td><a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-linux-aarch64.tar.gz"></a> <a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-linux-x86_64.tar.gz"></a> </td></tr>
+<table class="markdownTable">
+<tr class="markdownTableHead">
+<th class="markdownTableHeadNone">Operating System </th><th class="markdownTableHeadNone">Architecture-specific Release Archive (Download) </th></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">Android (AAR) </td><td class="markdownTableBodyNone"><a href="https://github.com/ARM-software/armnn/releases/download/v23.02/armnn_delegate_jni-23.02.aar"><img src="https://img.shields.io/badge/download-android--aar-orange" alt="" class="inline"/></a> </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyNone">Android 10 "Q/Quince Tart" (API level 29) </td><td class="markdownTableBodyNone"><a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-29-arm64-v8.2-a.tar.gz"><img src="https://img.shields.io/badge/download-arm64--v8.2a-blue" alt="" class="inline"/></a> <a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-29-arm64-v8a.tar.gz"><img src="https://img.shields.io/badge/download-arm64--v8a-red" alt="" class="inline"/></a> </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">Android 11 "R/Red Velvet Cake" (API level 30) </td><td class="markdownTableBodyNone"><a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-30-arm64-v8.2-a.tar.gz"><img src="https://img.shields.io/badge/download-arm64--v8.2a-blue" alt="" class="inline"/></a> <a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-30-arm64-v8a.tar.gz"><img src="https://img.shields.io/badge/download-arm64--v8a-red" alt="" class="inline"/></a> </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyNone">Android 12 "S/Snow Cone" (API level 31) </td><td class="markdownTableBodyNone"><a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-31-arm64-v8.2-a.tar.gz"><img src="https://img.shields.io/badge/download-arm64--v8.2a-blue" alt="" class="inline"/></a> <a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-31-arm64-v8a.tar.gz"><img src="https://img.shields.io/badge/download-arm64--v8a-red" alt="" class="inline"/></a> </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">Android 13 "T/Tiramisu" (API level 32) </td><td class="markdownTableBodyNone"><a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-32-arm64-v8.2-a.tar.gz"><img src="https://img.shields.io/badge/download-arm64--v8.2a-blue" alt="" class="inline"/></a> <a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-android-32-arm64-v8a.tar.gz"><img src="https://img.shields.io/badge/download-arm64--v8a-red" alt="" class="inline"/></a> </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyNone">Linux </td><td class="markdownTableBodyNone"><a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-linux-aarch64.tar.gz"><img src="https://img.shields.io/badge/download-aarch64-green" alt="" class="inline"/></a> <a href="https://github.com/ARM-software/armnn/releases/download/v23.02/ArmNN-linux-x86_64.tar.gz"><img src="https://img.shields.io/badge/download-x86__64-yellow" alt="" class="inline"/></a> </td></tr>
</table>
<h2>Software Overview</h2>
<p>The Arm NN SDK supports ML models in <b>TensorFlow Lite</b> (TF Lite) and <b>ONNX</b> formats.</p>
@@ -171,52 +171,53 @@ $(document).ready(function(){initNavTree('index.xhtml','');});
<p>If you find something that concerns you, please email <a href="#" onclick="location.href='mai'+'lto:'+'ter'+'ms'+'@ar'+'m.'+'com'; return false;">terms<span style="display: none;">.nosp@m.</span>@arm<span style="display: none;">.nosp@m.</span>.com</a></p>
<h2>Third-party</h2>
<p>Third party tools used by Arm NN:</p>
-<table class="doxtable">
-<tr>
-<th>Tool </th><th>License (SPDX ID) </th><th>Description </th><th>Version </th><th>Provenience </th></tr>
-<tr>
-<td>cxxopts </td><td>MIT </td><td>A lightweight C++ option parser library </td><td>SHA 12e496da3d486b87fa9df43edea65232ed852510 </td><td><a href="https://github.com/jarro2783/cxxopts">https://github.com/jarro2783/cxxopts</a> </td></tr>
-<tr>
-<td>doctest </td><td>MIT </td><td>Header-only C++ testing framework </td><td>2.4.6 </td><td><a href="https://github.com/onqtam/doctest">https://github.com/onqtam/doctest</a> </td></tr>
-<tr>
-<td>fmt </td><td>MIT </td><td>{fmt} is an open-source formatting library providing a fast and safe alternative to C stdio and C++ iostreams. </td><td>7.0.1 </td><td><a href="https://github.com/fmtlib/fmt">https://github.com/fmtlib/fmt</a> </td></tr>
-<tr>
-<td>ghc </td><td>MIT </td><td>A header-only single-file std::filesystem compatible helper library </td><td>1.3.2 </td><td><a href="https://github.com/gulrak/filesystem">https://github.com/gulrak/filesystem</a> </td></tr>
-<tr>
-<td>half </td><td>MIT </td><td>IEEE 754 conformant 16-bit half-precision floating point library </td><td>1.12.0 </td><td><a href="http://half.sourceforge.net">http://half.sourceforge.net</a> </td></tr>
-<tr>
-<td>mapbox/variant </td><td>BSD </td><td>A header-only alternative to 'boost::variant' </td><td>1.1.3 </td><td><a href="https://github.com/mapbox/variant">https://github.com/mapbox/variant</a> </td></tr>
-<tr>
-<td>stb </td><td>MIT </td><td>Image loader, resize and writer </td><td>2.16 </td><td><a href="https://github.com/nothings/stb">https://github.com/nothings/stb</a> </td></tr>
+<table class="markdownTable">
+<tr class="markdownTableHead">
+<th class="markdownTableHeadNone">Tool </th><th class="markdownTableHeadNone">License (SPDX ID) </th><th class="markdownTableHeadNone">Description </th><th class="markdownTableHeadNone">Version </th><th class="markdownTableHeadNone">Provenience </th></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">cxxopts </td><td class="markdownTableBodyNone">MIT </td><td class="markdownTableBodyNone">A lightweight C++ option parser library </td><td class="markdownTableBodyNone">SHA 12e496da3d486b87fa9df43edea65232ed852510 </td><td class="markdownTableBodyNone"><a href="https://github.com/jarro2783/cxxopts">https://github.com/jarro2783/cxxopts</a> </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyNone">doctest </td><td class="markdownTableBodyNone">MIT </td><td class="markdownTableBodyNone">Header-only C++ testing framework </td><td class="markdownTableBodyNone">2.4.6 </td><td class="markdownTableBodyNone"><a href="https://github.com/onqtam/doctest">https://github.com/onqtam/doctest</a> </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">fmt </td><td class="markdownTableBodyNone">MIT </td><td class="markdownTableBodyNone">{fmt} is an open-source formatting library providing a fast and safe alternative to C stdio and C++ iostreams. </td><td class="markdownTableBodyNone">7.0.1 </td><td class="markdownTableBodyNone"><a href="https://github.com/fmtlib/fmt">https://github.com/fmtlib/fmt</a> </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyNone">ghc </td><td class="markdownTableBodyNone">MIT </td><td class="markdownTableBodyNone">A header-only single-file std::filesystem compatible helper library </td><td class="markdownTableBodyNone">1.3.2 </td><td class="markdownTableBodyNone"><a href="https://github.com/gulrak/filesystem">https://github.com/gulrak/filesystem</a> </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">half </td><td class="markdownTableBodyNone">MIT </td><td class="markdownTableBodyNone">IEEE 754 conformant 16-bit half-precision floating point library </td><td class="markdownTableBodyNone">1.12.0 </td><td class="markdownTableBodyNone"><a href="http://half.sourceforge.net">http://half.sourceforge.net</a> </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyNone">mapbox/variant </td><td class="markdownTableBodyNone">BSD </td><td class="markdownTableBodyNone">A header-only alternative to 'boost::variant' </td><td class="markdownTableBodyNone">1.1.3 </td><td class="markdownTableBodyNone"><a href="https://github.com/mapbox/variant">https://github.com/mapbox/variant</a> </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">stb </td><td class="markdownTableBodyNone">MIT </td><td class="markdownTableBodyNone">Image loader, resize and writer </td><td class="markdownTableBodyNone">2.16 </td><td class="markdownTableBodyNone"><a href="https://github.com/nothings/stb">https://github.com/nothings/stb</a> </td></tr>
</table>
<h2>Build Flags</h2>
<p>Arm NN uses the following security related build flags in their code:</p>
-<table class="doxtable">
-<tr>
-<th>Build flags </th></tr>
-<tr>
-<td>-Wall </td></tr>
-<tr>
-<td>-Wextra </td></tr>
-<tr>
-<td>-Wold-style-cast </td></tr>
-<tr>
-<td>-Wno-missing-braces </td></tr>
-<tr>
-<td>-Wconversion </td></tr>
-<tr>
-<td>-Wsign-conversion </td></tr>
-<tr>
-<td>-Werror </td></tr>
+<table class="markdownTable">
+<tr class="markdownTableHead">
+<th class="markdownTableHeadNone">Build flags </th></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">-Wall </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyNone">-Wextra </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">-Wold-style-cast </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyNone">-Wno-missing-braces </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">-Wconversion </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyNone">-Wsign-conversion </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">-Werror </td></tr>
</table>
-</div></div><!-- contents -->
+</div></div><!-- PageDoc -->
+</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 Fri Feb 24 2023 10:24:34 for ArmNN by
+ <li class="footer">Generated on Wed Mar 22 2023 15:53:10 for ArmNN by
<a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
generated by cgit v1.2.1 (git 2.23.0) at 2024-05-23 14:46:17 +0000