aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSadik Armagan <sadik.armagan@arm.com>2020-11-25 11:41:06 +0000
committerFrancis Murtagh <francis.murtagh@arm.com>2020-11-25 13:07:54 +0000
commit2786a12e4ddf7d2efffc40a9853fc216dbab48f9 (patch)
tree24c1b13827cedf08de4cb19eaf1827793938f6f0
parente15e0c0e8c02a07c77e8aa6d2567ec7513e53c54 (diff)
downloadandroid-nn-driver-branches/android-nn-driver_20_11.tar.gz
IVGCVSW-5347 Update Android-NN driver FAQ.md and IntegratorsGuide.md.v20.11branches/android-nn-driver_20_11
FAQ.md: * Reducing the priority of Boost in one FAQ entry. * Changing the tense of another entry referring to the upcoming Android 10 release. IntegratorsGuide.md * Added reference to Android R in prerequisites section. * Added references to Android R in several sections. * Removed references to "pre-release" Android R. Signed-off-by: Colm Donelan <Colm.Donelan@arm.com> Signed-off-by: Sadik Armagan <sadik.armagan@arm.com> Change-Id: If2a07908dc8d2157532859e25afdd70fe7827c93
-rw-r--r--docs/FAQ.md9
-rw-r--r--docs/IntegratorGuide.md14
2 files changed, 10 insertions, 13 deletions
diff --git a/docs/FAQ.md b/docs/FAQ.md
index c09ee2e..8402571 100644
--- a/docs/FAQ.md
+++ b/docs/FAQ.md
@@ -20,19 +20,18 @@ An acceptable workaround is to increase the timeout defined in AndroidTest.xml,
Problems seen when trying to build the android-nn-driver obtained from GitHub
-----------------------------------------------------------------------------
-Some users have encountered difficulties when attempting to build copies of the android-nn-driver obtained from GitHub. The build reports missing module source paths from boost_1_64_0, clframework or armnn. These errors can look like this:
+Some users have encountered difficulties when attempting to build copies of the android-nn-driver obtained from GitHub. The build reports missing module source paths from armnn, clframework or boost_1_64_0. These errors can look like this:
-'error: vendor/arm/android-nn-driver/Android.bp:892:1: module "libboost_program_options" variant "android_arm_variant": module source path "vendor/arm/android-nn-driver/boost_1_64_0" does not exist'
'error: vendor/arm/android-nn-driver/Android.bp:45:1: variant "android_arm64_armv7": module "armnn-arm_compute" "module source path "vendor/arm/android-nn-driver/clframework/build/android-arm64v8a/src/core/CL" does not exist'
-These errors are due to missing dependencies or incompatiblities between the android-nn-driver and armnn or clframework versions. The android-nn-driver requires boost_1_64_0 to build. The versions of android-nn-driver, armnn and clframework will have to match for them to work together. For example, the 19.08 version of android-nn-driver, clframework and armnn will work together but none of them will work with earlier or later versions of the others.
+These errors are due to missing dependencies or incompatiblities between the android-nn-driver and armnn or clframework versions. The android-nn-driver requires boost_1_64_0 to build unit tests. The versions of android-nn-driver, armnn and clframework will have to match for them to work together. For example, the 19.08 version of android-nn-driver, clframework and armnn will work together but none of them will work with earlier or later versions of the others.
In order to ensure that the correct versions of boost, armnn and the clframework are obtained you can do the following:
1. Delete or move any boost, armnn or clframework directories from the android-nn-driver directory.
2. Run the setup.sh script in the android-nn-driver directory.
-This will download the correct versions of boost, armnn and the clframework and the android-nn-driver should build correctly. Alternatively you can go to the GitHub pages for android-nn-driver, armnn and computelibrary (clframework) and download versions with the same release tag.
+This will download the correct versions of boost, armnn and the clframework and the android-nn-driver should build correctly. Alternatively you can go to the GitHub pages for android-nn-driver, armnn and computelibrary (clframework) and download versions with the same release tag.
As an example, for 20.05 these would be:
@@ -47,7 +46,7 @@ https://www.boost.org/
Instance Normalization test failures
------------------------------------
-There is a known issue in the Android NNAPI implementation of Instance Normalization that will be fixed in an upcoming revision of Android 10. Using the Arm NN Android NNAPI driver with versions of the Android 10 VTS and CTS tests that do not have that fix will generate multiple Instance Normalization failures.
+There is a known issue in the Android NNAPI implementation of Instance Normalization that has been verified as fixed from Android 10 r39 onwards. Using the Arm NN Android NNAPI driver with versions of the Android 10 VTS and CTS tests that do not have that fix will generate multiple Instance Normalization test failures.
VTS and CTS test failures
-------------------------
diff --git a/docs/IntegratorGuide.md b/docs/IntegratorGuide.md
index c06cfd7..2d4ebdb 100644
--- a/docs/IntegratorGuide.md
+++ b/docs/IntegratorGuide.md
@@ -7,10 +7,9 @@ This document describes how to integrate the Arm NN Android NNAPI driver into an
1. Android source tree for Android P (we have tested against Android P version 9.0.0_r3) , in the directory `<ANDROID_ROOT>`
2. Android source tree for Android Q (we have tested against Android Q version 10.0.0_r39), in the directory `<ANDROID_ROOT>`
+2. Android source tree for Android R (we have tested against Android R version 11.0.0_r3), in the directory `<ANDROID_ROOT>`
3. Mali OpenCL driver integrated into the Android source tree
-Note: Arm NN Android NNAPI driver also supports pre-release version of Android R.
-
### Procedure
1. Place this source directory at `<ANDROID_ROOT>/vendor/arm/android-nn-driver`
@@ -21,12 +20,12 @@ To update the build environment, add to the contents of the variable `PRODUCT_PA
within the device-specific makefile that is located in the `<ANDROID_ROOT>/device/<manufacturer>/<product>`
directory. This file is normally called `device.mk`:
-For Android P or Q, using NN API version (1.0), the following should be added to `device.mk`:
+For Android P, Q or R, using NN API version (1.0), the following should be added to `device.mk`:
<pre>
PRODUCT_PACKAGES += android.hardware.neuralnetworks@1.0-service-armnn
</pre>
-For Android P or Q, a new version of the NN API is available (1.1),
+For Android P, Q or R, a new version of the NN API is available (1.1),
thus the following should be added to `device.mk` instead:
<pre>
PRODUCT_PACKAGES += android.hardware.neuralnetworks@1.1-service-armnn
@@ -38,7 +37,7 @@ thus the following should be added to `device.mk` instead:
PRODUCT_PACKAGES += android.hardware.neuralnetworks@1.2-service-armnn
</pre> `Android.mk` contains the module definition of all three versions (1.0, 1.1 and 1.2) of the ArmNN driver.
-For android.hardware.neuralnetworks@1.3 HAL,
+For Android R, new version of the NN API is available (1.3),
thus the following should be added to `device.mk` instead:
<pre>
PRODUCT_PACKAGES += android.hardware.neuralnetworks@1.3-service-armnn
@@ -51,9 +50,8 @@ ARMNN_COMPUTE_NEON_ENABLE or ARMNN_REF_ENABLE in `device.mk`:
ARMNN_COMPUTE_CL_ENABLE := 1
</pre>
-For Android P and Android Q the vendor manifest.xml requires the Neural Network HAL information.
-For Android P use HAL version 1.1 as below. For Android Q substitute 1.2 where necessary.
-For pre-release support of HAL version 1.3, substitute 1.3 where necessary.
+For Android P, Q and R the vendor manifest.xml requires the Neural Network HAL information.
+For Android P use HAL version 1.1 as below. For Android Q substitute 1.2 where necessary. For Android R substitute 1.3 where necessary.
```xml
<hal format="hidl">
<name>android.hardware.neuralnetworks</name>