aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikhil Raj <nikhil.raj@arm.com>2024-05-10 13:16:45 +0100
committerNikhil Raj <nikhil.raj@arm.com>2024-05-13 11:25:36 +0100
commit37be3457274d738aaa1d91d8f0effad9a984657d (patch)
treef7e5b162a80fca78ebd3a8461edb645a2ae2accc
parent2c2f3aa6fbdd50ab5157bfc40f9335337f14abac (diff)
downloadarmnn-37be3457274d738aaa1d91d8f0effad9a984657d.tar.gz
IVGCVSW-8259 Reivew and update documentation related with operators for 24.05
* Debug layer supported data types updated * Added deprecation notices in md files to functionalities that will be removed Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I8673bdc2d596bfa4de751fc95dae010b195ad0b1
-rw-r--r--docs/02_operator_list.dox5
-rw-r--r--docs/05_01_parsers.dox2
-rw-r--r--docs/05_04_supportlibrary.dox2
-rw-r--r--python/pyarmnn/README.md1
-rw-r--r--shim/BuildGuideShimSupportLibrary.md23
-rw-r--r--shim/sl/README.md1
-rw-r--r--src/armnnConverter/README.md2
-rw-r--r--src/backends/reference/RefWorkloadFactory.cpp2
8 files changed, 24 insertions, 14 deletions
diff --git a/docs/02_operator_list.dox b/docs/02_operator_list.dox
index 93e3db2680..1890a5630b 100644
--- a/docs/02_operator_list.dox
+++ b/docs/02_operator_list.dox
@@ -899,6 +899,7 @@ where N = batches, C = channels, H = height, W = width
<table>
<tr><th>
<tr><td>BFLOAT16
+ <tr><td>BOOLEAN
<tr><td>FLOAT16
<tr><td>FLOAT32
<tr><td>QASYMMS8
@@ -2975,10 +2976,6 @@ where N = batches, C = channels, H = height, W = width
<tr><th>
<tr><td>FLOAT16
<tr><td>FLOAT32
- <tr><td>QASYMMS8
- <tr><td>QASYMMU8
- <tr><td>QSYMMS8
- <tr><td>QSYMMS16
<tr><td>SIGNED32
</table>
<tr>
diff --git a/docs/05_01_parsers.dox b/docs/05_01_parsers.dox
index 03b8ea22a2..d85d364676 100644
--- a/docs/05_01_parsers.dox
+++ b/docs/05_01_parsers.dox
@@ -24,6 +24,8 @@ bindings take a look into the @ref md_python_pyarmnn_README section.
@section S5_onnx_parser Arm NN Onnx Parser
+## Note: Arm NN will be dropping support for Onnx Parser in 24.08.
+
`armnnOnnxParser` is a library for loading neural networks defined in ONNX protobuf files into the Arm NN runtime.
## ONNX operators that the Arm NN SDK supports
diff --git a/docs/05_04_supportlibrary.dox b/docs/05_04_supportlibrary.dox
index c96c6f00d6..46a9c73388 100644
--- a/docs/05_04_supportlibrary.dox
+++ b/docs/05_04_supportlibrary.dox
@@ -11,6 +11,8 @@ namespace armnn
@section supportlibraryintro About the NNAPI Support Library
+## Note: Arm NN will be dropping support for NNAPI Support Library in 24.08.
+
If you need help building the Arm NN NNAPI Support Library, please take a look at our [build guide](shim/BuildGuideShimSupportLibrary.md).
@section sloptions Support Library Options
diff --git a/python/pyarmnn/README.md b/python/pyarmnn/README.md
index b510c361c7..a165f58609 100644
--- a/python/pyarmnn/README.md
+++ b/python/pyarmnn/README.md
@@ -1,5 +1,6 @@
# PyArmNN
+## Note: Arm NN will be dropping support for PyArmNN in 24.08.
PyArmNN is a python extension for [Arm NN SDK](https://developer.arm.com/ip-products/processors/machine-learning/arm-nn).
PyArmNN provides interface similar to Arm NN C++ Api.
Before you proceed with the project setup, you will need to checkout and build a corresponding Arm NN version.
diff --git a/shim/BuildGuideShimSupportLibrary.md b/shim/BuildGuideShimSupportLibrary.md
index 98c626fee0..8baa9a044d 100644
--- a/shim/BuildGuideShimSupportLibrary.md
+++ b/shim/BuildGuideShimSupportLibrary.md
@@ -1,5 +1,6 @@
# How to use the Android NDK to build Arm NN
+- [Deprecation Notice](#deprecation-notice)
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Download Arm NN](#download-arm-nn)
@@ -9,6 +10,9 @@
- [Build Arm NN Shim](#build-arm-nn-shim)
+## Deprecation Notice
+Arm NN will be dropping support for support library in 24.08.
+
## Introduction
These are step by step instructions for building the Arm NN shim and support library for NNAPI.
This work is currently in an experimental phase.
@@ -16,7 +20,7 @@ This work is currently in an experimental phase.
## Prerequisites
The following are required to build the Arm NN support library
-* Android NDK r25
+* Android NDK r26b
* Detailed setup can be found in [BuildGuideAndroidNDK.md](../BuildGuideAndroidNDK.md)
* Flatbuffer version 23.5.26
* Detailed setup can be found in [BuildGuideCrossCompilation.md](../BuildGuideCrossCompilation.md)
@@ -33,7 +37,7 @@ export WORKING_DIR=<path to where the Arm NN source code, clframework and aosp r
export AOSP_ROOT=<path to the root of Android tree where the shim will be built>
export AOSP_MODULES_ROOT=<path to where AOSP modules will be cloned i.e. $WORKING_DIR/aosp>
export ARMNN_BUILD_DIR=<path to the Arm NN build directory i.e. $WORKING_DIR/build>
-export NDK=<path to>android-ndk-r25
+export NDK=<path to>android-ndk-r26b
export NDK_TOOLCHAIN_ROOT=$NDK/toolchains/llvm/prebuilt/linux-x86_64
export PATH=$NDK_TOOLCHAIN_ROOT/bin/:$PATH
export FLATBUFFERS_ANDROID_BUILD=<path to flatbuffers target android build>
@@ -68,7 +72,7 @@ cd ${WORKING_DIR}/clframework
scons arch=arm64-v8a \
toolchain_prefix=aarch64-linux-android- \
-compiler_prefix=aarch64-linux-android29- \
+compiler_prefix=aarch64-linux-android${ANDROID_API}- \
neon=1 opencl=1 \
embed_kernels=1 \
build_dir=android-arm64v8a \
@@ -76,6 +80,7 @@ extra_cxx_flags="-Wno-parentheses-equality -Wno-missing-braces -fPIC" \
Werror=0 embed_kernels=1 examples=0 \
validation_tests=0 benchmark_tests=0 benchmark_examples=0 os=android -j16
```
+Note: ANDROID_API is the Android API version you want to build.
## Build Arm NN and Serializer
@@ -83,12 +88,12 @@ validation_tests=0 benchmark_tests=0 benchmark_examples=0 os=android -j16
(Requires CMake if not previously installed: `sudo apt install cmake`)
```bash
cd $ARMNN_BUILD_DIR
-CXX=aarch64-linux-android29-clang++ \
-CC=aarch64-linux-android29-clang \
+CXX=aarch64-linux-android${ANDROID_API}-clang++ \
+CC=aarch64-linux-android${ANDROID_API}-clang \
CXX_FLAGS="-fPIE -fPIC" cmake ${WORKING_DIR}/armnn \
-DCMAKE_ANDROID_NDK=$NDK \
-DCMAKE_SYSTEM_NAME=Android \
--DCMAKE_SYSTEM_VERSION=29 \
+-DCMAKE_SYSTEM_VERSION=$ANDROID_API \
-DCMAKE_ANDROID_ARCH_ABI=arm64-v8a \
-DCMAKE_EXE_LINKER_FLAGS="-pie -llog -lz" \
-DARMCOMPUTE_ROOT=$WORKING_DIR/clframework/ \
@@ -125,7 +130,7 @@ CMARGS="$CMARGS \
-DANDROID_ABI=arm64-v8a \
-DCMAKE_ANDROID_ARCH_ABI=arm64-v8a \
-DCMAKE_ANDROID_NDK=$NDK \
--DANDROID_PLATFORM=android-29 \
+-DANDROID_PLATFORM=android-$ANDROID_API \
-DAOSP_MODULES_ROOT=$AOSP_MODULES_ROOT \
-DARMNN_SOURCE_DIR=$WORKING_DIR/armnn \
-DArmnn_DIR=$ARMNN_BUILD_DIR "
@@ -133,8 +138,8 @@ CMARGS="$CMARGS \
mkdir ${WORKING_DIR}/armnn/shim/sl/build
cd ${WORKING_DIR}/armnn/shim/sl/build
-CXX=aarch64-linux-android29-clang++ \
-CC=aarch64-linux-android29-clang \
+CXX=aarch64-linux-android$ANDROID_API-clang++ \
+CC=aarch64-linux-android$ANDROID_API-clang \
cmake $CMARGS ../
make
```
diff --git a/shim/sl/README.md b/shim/sl/README.md
index 32f117a562..3a099dd24a 100644
--- a/shim/sl/README.md
+++ b/shim/sl/README.md
@@ -1,6 +1,7 @@
# Arm NN Support Library Neural Networks driver
This directory contains the Arm NN Support Library for the Android Neural Networks API.
+### Note: Arm NN will be dropping support for Support Library in 24.08.
# Passing parameters to the support library runtime.
diff --git a/src/armnnConverter/README.md b/src/armnnConverter/README.md
index 6c8ab27458..a1f29d9fbe 100644
--- a/src/armnnConverter/README.md
+++ b/src/armnnConverter/README.md
@@ -1,5 +1,7 @@
# The ArmnnConverter
+## Note: Arm NN will be dropping support for ArmnnConverter in 24.08.
+
The `ArmnnConverter` is a program for converting neural networks from other formats to Arm NN format.
Currently the program supports models in Onnx and Tensorflow Lite FlatBuffers formats.
Run the program with no arguments to see command-line help.
diff --git a/src/backends/reference/RefWorkloadFactory.cpp b/src/backends/reference/RefWorkloadFactory.cpp
index 086f8eea8d..76c18a4fd6 100644
--- a/src/backends/reference/RefWorkloadFactory.cpp
+++ b/src/backends/reference/RefWorkloadFactory.cpp
@@ -279,7 +279,7 @@ std::unique_ptr<IWorkload> RefWorkloadFactory::CreateWorkload(LayerType type,
{
return std::make_unique<RefDebugBooleanWorkload>(*debugQueueDescriptor, info);
}
- return MakeWorkload<RefDebugFloat32Workload, RefDebugQAsymmU8Workload>(*debugQueueDescriptor, info);
+ return MakeWorkload<RefDebugFloat32Workload, RefDebugQAsymmU8Workload>(*debugQueueDescriptor, info);
}
case LayerType::DepthToSpace:
{