Updating Doxygen documentation for 20.05 release.

Change-Id: I4d624343ed5fd6ae269c3d53532903084508fd14 Signed-off-by: Colm Donelan <Colm.Donelan@arm.com>
author: Colm Donelan <Colm.Donelan@arm.com> 2020-05-20 16:12:19 +0100
committer: Colm Donelan <Colm.Donelan@arm.com> 2020-05-29 10:28:40 +0100
commit: a983e4699082a0b1ef685bab7354f2ad9cd37a44 (patch)
tree: 4fa94e7ab27053461b481cfbdc1b7c17ca475ac6 /20.05/serializers.xhtml
parent: 764d50a3271dea43a6e9273e6dfd98990281c654 (diff)
download: armnn-a983e4699082a0b1ef685bab7354f2ad9cd37a44.tar.gz
1 files changed, 258 insertions, 0 deletions
diff --git a/20.05/serializers.xhtml b/20.05/serializers.xhtml
new file mode 100644
index 0000000000..9704285c1a
--- /dev/null
+++ b/20.05/serializers.xhtml
@@ -0,0 +1,258 @@
+<!-- Copyright (c) 2020 ARM Limited. -->
+<!--                                 -->
+<!-- SPDX-License-Identifier: MIT    -->
+<!--                                 -->
+<!-- HTML header for doxygen 1.8.13-->
+<!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"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="robots" content="NOINDEX, NOFOLLOW" />
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>ArmNN: The ArmNN Serializer and Deserializer</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<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>
+<script type="text/x-mathjax-config">
+  MathJax.Hub.Config({
+    extensions: ["tex2jax.js"],
+    jax: ["input/TeX","output/HTML-CSS"],
+});
+</script><script type="text/javascript" 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>
+<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: 56px;">
+  <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
+  <td style="padding-left: 0.5em;">
+   <div id="projectname">
+   &#160;<span id="projectnumber">20.05</span>
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></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('serializers.xhtml','');});
+</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)">
+</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">The ArmNN Serializer and Deserializer </div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="toc"><h3>Table of Contents</h3>
+<ul><li class="level1"><a href="#S8_serializer">The ArmNN Serializer</a></li>
+<li class="level1"><a href="#S9_deserializer">The ArmNN Deserializer</a></li>
+</ul>
+</div>
+<div class="textblock"><h1><a class="anchor" id="S8_serializer"></a>
+The ArmNN Serializer</h1>
+<p>The <code><a class="el" href="namespacearmnn_serializer.xhtml">armnnSerializer</a></code> is a library for serializing an Arm NN network to a stream.</p>
+<h2>The layers that ArmNN SDK Serializer currently supports.</h2>
+<p>This reference guide provides a list of layers which can be serialized currently by the Arm NN SDK.</p>
+<h2>Fully supported</h2>
+<p>The Arm NN SDK Serializer currently supports the following layers:</p>
+<ul>
+<li>Activation</li>
+<li>Addition</li>
+<li>ArgMinMax</li>
+<li>BatchToSpaceNd</li>
+<li>BatchNormalization</li>
+<li>Comparison</li>
+<li>Concat</li>
+<li>Constant</li>
+<li>Convolution2d</li>
+<li>DepthToSpace</li>
+<li>DepthwiseConvolution2d</li>
+<li>Dequantize</li>
+<li>DetectionPostProcess</li>
+<li>Division</li>
+<li>ElementwiseUnary</li>
+<li>Floor</li>
+<li>FullyConnected</li>
+<li>Gather</li>
+<li>Input</li>
+<li>InstanceNormalization</li>
+<li>L2Normalization</li>
+<li>LogSoftmax</li>
+<li>Lstm</li>
+<li>Maximum</li>
+<li>Mean</li>
+<li>Merge</li>
+<li>Minimum</li>
+<li>Multiplication</li>
+<li>Normalization</li>
+<li>Output</li>
+<li>Pad</li>
+<li>Permute</li>
+<li>Pooling2d</li>
+<li>Prelu</li>
+<li>Quantize</li>
+<li>QuantizedLstm</li>
+<li>Reshape</li>
+<li>Resize</li>
+<li>Slice</li>
+<li>Softmax</li>
+<li>SpaceToBatchNd</li>
+<li>SpaceToDepth</li>
+<li>Splitter</li>
+<li>Stack</li>
+<li>StandIn</li>
+<li>StridedSlice</li>
+<li>Subtraction</li>
+<li>Switch</li>
+<li>TransposeConvolution2d</li>
+</ul>
+<p>More machine learning layers will be supported in future releases.</p>
+<h2>Deprecated layers</h2>
+<p>Some layers have been deprecated and replaced by others layers. In order to maintain backward compatibility, serializations of these deprecated layers will deserialize to the layers that have replaced them, as follows:</p>
+<ul>
+<li>Equal will deserialize as Comparison</li>
+<li>Merger will deserialize as Concat</li>
+<li>Greater will deserialize as Comparison</li>
+<li>ResizeBilinear will deserialize as Resize</li>
+<li>Abs will deserialize as ElementwiseUnary</li>
+<li>Rsqrt will deserialize as ElementwiseUnary <br />
+<br />
+<br />
+<br />
+</li>
+</ul>
+<h1><a class="anchor" id="S9_deserializer"></a>
+The ArmNN Deserializer</h1>
+<p>The <code><a class="el" href="namespacearmnn_deserializer.xhtml">armnnDeserializer</a></code> is a library for loading neural networks defined by Arm NN FlatBuffers files into the Arm NN runtime.</p>
+<h2>The layers that ArmNN SDK Deserializer currently supports.</h2>
+<p>This reference guide provides a list of layers which can be deserialized currently by the Arm NN SDK.</p>
+<h2>Fully supported</h2>
+<p>The Arm NN SDK Deserialize parser currently supports the following layers:</p>
+<ul>
+<li>Abs</li>
+<li>Activation</li>
+<li>Addition</li>
+<li>ArgMinMax</li>
+<li>BatchToSpaceNd</li>
+<li>BatchNormalization</li>
+<li>Concat</li>
+<li>Comparison</li>
+<li>Constant</li>
+<li>Convolution2d</li>
+<li>DepthToSpace</li>
+<li>DepthwiseConvolution2d</li>
+<li>Dequantize</li>
+<li>DetectionPostProcess</li>
+<li>Division</li>
+<li>Floor</li>
+<li>FullyConnected</li>
+<li>Gather</li>
+<li>Input</li>
+<li>InstanceNormalization</li>
+<li>L2Normalization</li>
+<li>LogSoftmax</li>
+<li>Lstm</li>
+<li>Maximum</li>
+<li>Mean</li>
+<li>Merge</li>
+<li>Minimum</li>
+<li>Multiplication</li>
+<li>Normalization</li>
+<li>Output</li>
+<li>Pad</li>
+<li>Permute</li>
+<li>Pooling2d</li>
+<li>Prelu</li>
+<li>Quantize</li>
+<li>QuantizedLstm</li>
+<li>Reshape</li>
+<li>Rsqrt</li>
+<li>Slice</li>
+<li>Softmax</li>
+<li>SpaceToBatchNd</li>
+<li>SpaceToDepth</li>
+<li>Splitter</li>
+<li>Stack</li>
+<li>StandIn</li>
+<li>StridedSlice</li>
+<li>Subtraction</li>
+<li>Switch</li>
+<li>TransposeConvolution2d</li>
+<li>Resize</li>
+</ul>
+<p>More machine learning layers will be supported in future releases.</p>
+<h2>Deprecated layers</h2>
+<p>Some layers have been deprecated and replaced by others layers. In order to maintain backward compatibility, serializations of these deprecated layers will deserialize to the layers that have replaced them, as follows:</p>
+<ul>
+<li>Equal will deserialize as Comparison</li>
+<li>Merger will deserialize as Concat</li>
+<li>Greater will deserialize as Comparison</li>
+<li>ResizeBilinear will deserialize as Resize </li>
+</ul>
+</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 Fri May 29 2020 10:20:49 for ArmNN by
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
+  </ul>
+</div>
+</body>
+</html>
author	Colm Donelan <Colm.Donelan@arm.com>	2020-05-20 16:12:19 +0100
committer	Colm Donelan <Colm.Donelan@arm.com>	2020-05-29 10:28:40 +0100
commit	a983e4699082a0b1ef685bab7354f2ad9cd37a44 (patch)
tree	4fa94e7ab27053461b481cfbdc1b7c17ca475ac6 /20.05/serializers.xhtml
parent	764d50a3271dea43a6e9273e6dfd98990281c654 (diff)
download	armnn-a983e4699082a0b1ef685bab7354f2ad9cd37a44.tar.gz