aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikhil Raj <nikhil.raj@arm.com>2022-02-15 14:16:30 +0000
committerNikhil Raj <nikhil.raj@arm.com>2022-02-16 09:59:51 +0000
commit29520c4c785fff938586ec231cbf5e51dadbf614 (patch)
treef8355bc5683229348f09b96035a415adca89e09a
parent2048b68cf7caf14e03ceaf84d841bda7bbda8c75 (diff)
downloadandroid-nn-driver-29520c4c785fff938586ec231cbf5e51dadbf614.tar.gz
Document updates
* Added a note in the Integrator guide for the new error while building android * Removed boost from FAQs Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I1dc08bf2ff772550ac4e766bdf791301ea11cd5c
-rw-r--r--docs/FAQ.md25
-rw-r--r--docs/IntegratorGuide.md2
2 files changed, 12 insertions, 15 deletions
diff --git a/docs/FAQ.md b/docs/FAQ.md
index bd79bb04..dd96a249 100644
--- a/docs/FAQ.md
+++ b/docs/FAQ.md
@@ -20,31 +20,28 @@ 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 armnn, clframework, flatbuffers-1.12.0 or boost_1_64_0.
+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 flatbuffers-1.12.0.
These errors can look
like this:
'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 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.
+These errors are due to missing dependencies or incompatiblities between the android-nn-driver and armnn or clframework versions. The versions of android-nn-driver, armnn and clframework will have to match for them to work together. For example, the 22.02 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 flatbuffers, boost, armnn and the clframework are obtained you can do the following:
+In order to ensure that the correct versions of flatbuffers, armnn and the clframework are obtained you can do the following:
-1. Delete or move any flatbuffers, boost, armnn or clframework directories from the android-nn-driver directory.
+1. Delete or move any flatbuffers, 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 flatbuffers, boost, armnn and the clframework and the android-nn-driver should build
+This will download the correct versions of flatbuffers, 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:
+As an example, for 22.02 these would be:
-https://github.com/ARM-software/android-nn-driver/tree/v20.05
-https://github.com/ARM-software/armnn/tree/v20.05
-https://github.com/ARM-software/computelibrary/tree/v20.05
+https://github.com/ARM-software/android-nn-driver/tree/v22.02
+https://github.com/ARM-software/armnn/tree/v22.02
+https://github.com/ARM-software/computelibrary/tree/v22.02
-The correct version of boost (1_64_0) can be downloaded from:
-
-https://www.boost.org/
The correct version of flatbuffers (1.12.0) can be downloaded from:
@@ -58,7 +55,7 @@ There is a known issue in the Android NNAPI implementation of Instance Normaliza
VTS and CTS test failures
-------------------------
-With the release of the Android 10 R2 CTS some errors and crashes were discovered in the 19.08 and 19.11 releases of armnn, the android-nn-driver and ComputeLibrary. 19.08.01 and 19.11.01 releases of armnn, the android-nn-driver and ComputeLibrary were prepared that fix all these issues on CpuAcc and GpuAcc. If using 19.08 or 19.11 we recommend that you upgrade to the 19.08.01 or 19.11.01 releases. These issues have also been fixed in the 20.02 and later releases of armnn, the android-nn-driver and ComputeLibrary.
+With the release of the Android 10 R2 CTS some errors and crashes were discovered in the 19.08 and 19.11 releases of armnn, the android-nn-driver and ComputeLibrary. 19.08.01 and 19.11.01 releases of armnn, the android-nn-driver and ComputeLibrary were prepared that fix all these issues on CpuAcc and GpuAcc. If using 19.08 or 19.11 we recommend that you upgrade to the latest releases.
These fixes also required patches to be made to the Android Q test framework. You may encounter CTS and VTS test failures when attempting to build copies of the android-nn-driver against older versions of Android Q.
@@ -75,4 +72,4 @@ In order to fix these failures you will have to update to a version of Android Q
The Android 10 R3 CTS that can be downloaded from https://source.android.com/compatibility/cts/downloads contains all these patches.
-There is a known issue that even with these patches CTS tests "TestRandomGraph/RandomGraphTest#LargeGraph_TENSOR_FLOAT16_Rank3/41" and "TestRandomGraph/RandomGraphTest#LargeGraph_TENSOR_FLOAT16_Rank2/20 " will still fail on CpuRef. These failures are caused by a LogSoftmax layer followed by a Floor layer which blows up the slight difference between fp16 to fp32. This issue only affects CpuRef with Android Q. These tests are not failing for Android R. \ No newline at end of file
+There is a known issue that even with these patches CTS tests "TestRandomGraph/RandomGraphTest#LargeGraph_TENSOR_FLOAT16_Rank3/41" and "TestRandomGraph/RandomGraphTest#LargeGraph_TENSOR_FLOAT16_Rank2/20 " will still fail on CpuRef. These failures are caused by a LogSoftmax layer followed by a Floor layer which blows up the slight difference between fp16 to fp32. This issue only affects CpuRef with Android Q. These tests are not failing for Android R.
diff --git a/docs/IntegratorGuide.md b/docs/IntegratorGuide.md
index e54a286f..4842a5f3 100644
--- a/docs/IntegratorGuide.md
+++ b/docs/IntegratorGuide.md
@@ -60,7 +60,7 @@ For Android P use HAL version 1.1 as below. For Android Q substitute 1.2 where n
</hal>
```
-4. Build Android as normal, i.e. run `make` in `<ANDROID_ROOT>`
+4. Build Android as normal (https://source.android.com/setup/build/building)
5. To confirm that the Arm NN driver has been built, check for the driver service executable at
Android P