aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRyan OShea <Ryan.OShea2@arm.com>2020-02-12 16:15:27 +0000
committerJim Flynn <jim.flynn@arm.com>2020-03-11 21:25:07 +0000
commit2bbfaa784c0ea2e2b239470cfbe633026d53c9cb (patch)
tree0de6e92da7a3b6f2bff919cefe7a54a7aa679a80 /docs
parent5238aff21baf0b35c36ab0cc72c7a46888e3bd08 (diff)
downloadarmnn-2bbfaa784c0ea2e2b239470cfbe633026d53c9cb.tar.gz
IVGCVSW-3726 Doxygen touch-up
* Doxygen comment touch-ups * Fixed markup in .dox files * Fixed stylesheet * Doxyfile changes * Added logo file * Added header file Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com> Change-Id: I94c7f5a6923a0bbb5c6ed610f1f55d57e2bb8a49
Diffstat (limited to 'docs')
-rw-r--r--docs/00_introduction.dox3
-rw-r--r--docs/01_parsers.dox11
-rw-r--r--docs/02_deserializer_serializer.dox2
-rw-r--r--docs/03_converter_quantizer.dox2
-rw-r--r--docs/04_backends.dox4
-rw-r--r--docs/05_other_tools.dox2
-rw-r--r--docs/Arm_NN_horizontal_blue.pngbin0 -> 16540 bytes
-rw-r--r--docs/Doxyfile4
-rw-r--r--docs/header.xhtml55
-rw-r--r--docs/stylesheet.css14
10 files changed, 72 insertions, 25 deletions
diff --git a/docs/00_introduction.dox b/docs/00_introduction.dox
index 981e03387b..66006405f5 100644
--- a/docs/00_introduction.dox
+++ b/docs/00_introduction.dox
@@ -1,4 +1,4 @@
-/// Copyright (c) 2017 ARM Limited.
+/// Copyright (c) 2020 ARM Limited.
///
/// SPDX-License-Identifier: MIT
///
@@ -824,3 +824,4 @@ The instructions show how to build the ArmNN core library and the Boost, Protobu
**/
}
+
diff --git a/docs/01_parsers.dox b/docs/01_parsers.dox
index e73334744f..afa9b9c4f9 100644
--- a/docs/01_parsers.dox
+++ b/docs/01_parsers.dox
@@ -1,4 +1,4 @@
-/// Copyright (c) 2017 ARM Limited.
+/// Copyright (c) 2020 ARM Limited.
///
/// SPDX-License-Identifier: MIT
///
@@ -37,6 +37,7 @@ This reference guide provides a list of Caffe layers the Arm NN SDK currently su
## Although some other neural networks might work, Arm tests the Arm NN SDK with Caffe implementations of the following neural networks:
- AlexNet.
+- Cifar10.
- Inception-BN.
- Resnet_50, Resnet_101 and Resnet_152.
- VGG_CNN_S, VGG_16 and VGG_19.
@@ -44,9 +45,6 @@ This reference guide provides a list of Caffe layers the Arm NN SDK currently su
- Lenet.
- MobileNetv1.
-using these datasets:
-- Cifar10.
-
## The Arm NN SDK supports the following machine learning layers for Caffe networks:
- BatchNorm, in inference mode.
@@ -86,7 +84,7 @@ The Arm NN SDK ONNX parser currently only supports fp32 operators.
- Add
- See the ONNX [Add documentation](https://github.com/onnx/onnx/blob/master/docs/Operators.md#Add) for more information
--AveragePool
+- AveragePool
- See the ONNX [AveragePool documentation](https://github.com/onnx/onnx/blob/master/docs/Operators.md#AveragePool) for more information.
- Constant
- See the ONNX [Constant documentation](https://github.com/onnx/onnx/blob/master/docs/Operators.md#Constant) for more information.
@@ -209,7 +207,7 @@ The Arm NN SDK TensorFlow parser currently only supports fp32 operators.
- placeholder
- See the TensorFlow [placeholder documentation](https://www.tensorflow.org/api_docs/python/tf/placeholder) for more information.
- reduce_mean
- -See the TensorFlow [reduce_mean documentation](https://www.tensorflow.org/api_docs/python/tf/reduce_mean) for more information.
+ - See the TensorFlow [reduce_mean documentation](https://www.tensorflow.org/api_docs/python/tf/reduce_mean) for more information.
- relu
- See the TensorFlow [relu documentation](https://www.tensorflow.org/api_docs/python/tf/nn/relu) for more information.
- relu6
@@ -288,3 +286,4 @@ More machine learning operators will be supported in future releases.
**/
}
+
diff --git a/docs/02_deserializer_serializer.dox b/docs/02_deserializer_serializer.dox
index 1cd0516a1e..0bd677eb88 100644
--- a/docs/02_deserializer_serializer.dox
+++ b/docs/02_deserializer_serializer.dox
@@ -1,4 +1,4 @@
-/// Copyright (c) 2017 ARM Limited.
+/// Copyright (c) 2020 ARM Limited.
///
/// SPDX-License-Identifier: MIT
///
diff --git a/docs/03_converter_quantizer.dox b/docs/03_converter_quantizer.dox
index ebfacd473e..9b643f387a 100644
--- a/docs/03_converter_quantizer.dox
+++ b/docs/03_converter_quantizer.dox
@@ -1,4 +1,4 @@
-/// Copyright (c) 2017 ARM Limited.
+/// Copyright (c) 2020 ARM Limited.
///
/// SPDX-License-Identifier: MIT
///
diff --git a/docs/04_backends.dox b/docs/04_backends.dox
index cc6d01372e..e718895437 100644
--- a/docs/04_backends.dox
+++ b/docs/04_backends.dox
@@ -1,4 +1,4 @@
-/// Copyright (c) 2017 ARM Limited.
+/// Copyright (c) 2020 ARM Limited.
///
/// SPDX-License-Identifier: MIT
///
@@ -433,7 +433,7 @@ Layer Support API and the Workload Factory.
At the end of test, the runtime object goes out of scope and the dynamic backend instance is automatically destroyed, and the handle to
the shared object is closed.
-<br/><br/><br/><br/><br/>
+<br/><br/><br/><br/>
@section S13_dynamic_backend_guide Standalone Dynamic Backend Developer Guide
diff --git a/docs/05_other_tools.dox b/docs/05_other_tools.dox
index 898565443d..522e16f46a 100644
--- a/docs/05_other_tools.dox
+++ b/docs/05_other_tools.dox
@@ -1,4 +1,4 @@
-/// Copyright (c) 2017 ARM Limited.
+/// Copyright (c) 2020 ARM Limited.
///
/// SPDX-License-Identifier: MIT
///
diff --git a/docs/Arm_NN_horizontal_blue.png b/docs/Arm_NN_horizontal_blue.png
new file mode 100644
index 0000000000..3d27185240
--- /dev/null
+++ b/docs/Arm_NN_horizontal_blue.png
Binary files differ
diff --git a/docs/Doxyfile b/docs/Doxyfile
index 8f104cb41c..67a8eeb86e 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -74,7 +74,7 @@ PROJECT_BRIEF =
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
-PROJECT_LOGO =
+PROJECT_LOGO = ./docs/Arm_NN_horizontal_blue.png
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
@@ -1189,7 +1189,7 @@ HTML_FILE_EXTENSION = .xhtml
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_HEADER =
+HTML_HEADER = ./docs/header.xhtml
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
diff --git a/docs/header.xhtml b/docs/header.xhtml
new file mode 100644
index 0000000000..c08a619ba2
--- /dev/null
+++ b/docs/header.xhtml
@@ -0,0 +1,55 @@
+<!-- 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 $doxygenversion"/>
+<meta name="robots" content="NOINDEX, NOFOLLOW" />
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
+<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
+<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="$relpath^jquery.js"></script>
+<script type="text/javascript" src="$relpath^dynsections.js"></script>
+$treeview
+$search
+$mathjax
+<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
+$extrastylesheet
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+
+<!--BEGIN TITLEAREA-->
+<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"/>
+ <!--BEGIN PROJECT_NAME-->
+ <td style="padding-left: 0.5em;">
+ <div id="projectname">
+ <!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
+ </div>
+ <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
+ </td>
+ <!--END PROJECT_NAME-->
+ <!--BEGIN !PROJECT_NAME-->
+ <!--END !PROJECT_NAME-->
+ <!--BEGIN DISABLE_INDEX-->
+ <!--BEGIN SEARCHENGINE-->
+ <td>$searchbox</td>
+ <td><p>Hello World</p></td>
+ <!--END SEARCHENGINE-->
+ <!--END DISABLE_INDEX-->
+ </tr>
+ </tbody>
+</table>
+</div>
+<!--END TITLEAREA-->
+<!-- end header part -->
diff --git a/docs/stylesheet.css b/docs/stylesheet.css
index f6ed8aadb9..ea7f4dccc0 100644
--- a/docs/stylesheet.css
+++ b/docs/stylesheet.css
@@ -1,7 +1,7 @@
+/* Copyright (c) 2020 ARM Limited. */
/* Changes to tabs.css */
.tabs, .tabs2, .tabs3 {
- /* box-shadow: 0px 5px 30px rgba(0, 0, 0, 0.3); */
position: relative;
}
@@ -110,6 +110,8 @@ a.codeRef, a.codeRef:visited {
div.fragment {
background-color: #FCFCFC;
border: 1px solid #CFCFCF;
+ padding: 8px;
+ margin: 10px 2px;
}
div.line.glow {
@@ -124,10 +126,6 @@ body {
background-color: #007fa3;
}
-.memitem.glow {
- /* box-shadow: 0 0 15px orange; */
-}
-
.memproto, dl.reflist dt {
border-top: 1px solid #B8B8B8;
border-left: 1px solid #B8B8B8;
@@ -168,12 +166,6 @@ dl.note
border-color: #f68a33;
}
-#projectlogo
-{
- width:150px;
- text-align:left;
-}
-
#projectname
{
font: 200% Tahoma, Arial,sans-serif;