aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Eilers <jan.eilers@arm.com>2021-01-28 09:13:24 +0000
committerJan Eilers <jan.eilers@arm.com>2021-02-02 09:44:14 +0000
commitb65781933fb8fa5cf73a37b65c984cac8db16ca4 (patch)
tree0748eb52534a167ccb5c8f6bc8c6b326405f282f
parent06fabe12d7d115045517880bae78a4b973af7547 (diff)
downloadarmnn-b65781933fb8fa5cf73a37b65c984cac8db16ca4.tar.gz
IVGCVSW-5605 Doxygen: Integrate parsers into Software Tools section
* Creates new section in doxygen called "Software Tools" * Moves the Parser page into Software Tools Signed-off-by: Jan Eilers <jan.eilers@arm.com> Change-Id: I19643074226d7c2e73e560e3abb52f519af1a7b2
-rw-r--r--docs/00_software_tools.dox19
-rw-r--r--docs/01_parsers.dox5
-rw-r--r--docs/Doxyfile4
3 files changed, 25 insertions, 3 deletions
diff --git a/docs/00_software_tools.dox b/docs/00_software_tools.dox
new file mode 100644
index 0000000000..a970c91062
--- /dev/null
+++ b/docs/00_software_tools.dox
@@ -0,0 +1,19 @@
+/// Copyright (c) 2021 ARM Limited and Contributors. All rights reserved.
+///
+/// SPDX-License-Identifier: MIT
+///
+
+namespace armnn
+{
+/**
+@page swtools Software Tools
+
+On this page you can find all software tools contained in the ArmNN repository. You will find links to how-to guides and
+other helpful information in each section.
+
+@subpage parsers
+
+**/
+}
+
+
diff --git a/docs/01_parsers.dox b/docs/01_parsers.dox
index 1af2503f88..80d616f5e7 100644
--- a/docs/01_parsers.dox
+++ b/docs/01_parsers.dox
@@ -27,11 +27,14 @@ namespace armnn
@page parsers Parsers
@tableofcontents
+Execute models from different machine learning platforms efficiently with our parsers. Simply choose a parser according
+to the model you want to run e.g. If you've got a model in tensorflow format (<model_name>.pb) use our tensorflow-parser.
+
@section S4_caffe_parser ArmNN Caffe Parser
`armnnCaffeParser` is a library for loading neural networks defined in Caffe protobuf files into the Arm NN runtime.
-##Caffe layers supported by the Arm NN SDK
+## Caffe layers supported by the Arm NN SDK
This reference guide provides a list of Caffe layers the Arm NN SDK currently supports.
## Although some other neural networks might work, Arm tests the Arm NN SDK with Caffe implementations of the following neural networks:
diff --git a/docs/Doxyfile b/docs/Doxyfile
index e769e01b52..a0d6593be5 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -813,7 +813,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
-INPUT = ./docs/01_parsers.dox \
+INPUT = ./docs/00_software_tools.dox \
+ ./docs/01_parsers.dox \
./docs/02_deserializer_serializer.dox \
./docs/03_converter_quantizer.dox \
./docs/04_backends.dox \
@@ -821,7 +822,6 @@ INPUT = ./docs/01_parsers.dox \
./include/ \
./src/ \
./tests/ \
- ./docs/ \
./delegate/include \
./delegate/src/armnn_external_delegate.cpp \
./README.md \