diff options
author | James Conroy <james.conroy@arm.com> | 2022-11-18 10:17:27 +0000 |
---|---|---|
committer | James Conroy <james.conroy@arm.com> | 2022-11-18 10:17:27 +0000 |
commit | c8d7a663dbcc0b92793c79d88685982e7ca908a5 (patch) | |
tree | d123bca6d029999fef9fe99cb82403d01655f017 /build-tool/README.md | |
parent | 31441595009182c985dacbedc70c41ee6664d070 (diff) | |
download | armnn-c8d7a663dbcc0b92793c79d88685982e7ca908a5.tar.gz |
IVGCVSW-7330 Fix build-tool args for Docker builds
* This change requests users to supply a comma separated
string of CMake/scons args so that they can passed
down from Docker into the bash script correctly.
* Updated documentation to reflect this.
Signed-off-by: James Conroy <james.conroy@arm.com>
Change-Id: Icbd1d1458e11382936690ca6cc4417677e063ddb
Diffstat (limited to 'build-tool/README.md')
-rw-r--r-- | build-tool/README.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/build-tool/README.md b/build-tool/README.md index b56a6907c5..34c8998569 100644 --- a/build-tool/README.md +++ b/build-tool/README.md @@ -168,8 +168,8 @@ The ```BUILD_ARGS``` string should start and end with **double quotes** ```"```. | --cl-backend | **flag:** build Arm NN with the OpenCL backend (GPU acceleration from ACL) | | --ref-backend | **flag:** build Arm NN with the reference backend<br/>**Should be used for verification purposes only.<br/>Does not provide any performance acceleration.** | | --debug | **flag:** build Arm NN (and ACL) with debug turned on (optional: defaults to off) | -| --armnn-cmake-args= | **option:** provide additional space-separated CMake arguments string for building Arm NN (optional)<br/>String should start and end with **single quotes** ```'```<br/>Please refer to **armnn/cmake/GlobalConfig.cmake** | -| --acl-scons-params= | **option**: provide additional space-separated scons parameters string for building ACL (optional)<br/>String should start and end with **single quotes** ```'```<br/>ACL provide [documentation](https://arm-software.github.io/ComputeLibrary/latest/how_to_build.xhtml#S1_1_build_options) for their build options | +| --armnn-cmake-args= | **option:** provide additional comma-separated CMake arguments string for building Arm NN (optional)<br/>String should start and end with **single quotes** ```'```<br/>Please refer to **armnn/cmake/GlobalConfig.cmake** | +| --acl-scons-params= | **option**: provide additional comma-separated scons parameters string for building ACL (optional)<br/>String should start and end with **single quotes** ```'```<br/>ACL provide [documentation](https://arm-software.github.io/ComputeLibrary/latest/how_to_build.xhtml#S1_1_build_options) for their build options | **At least one component** (i.e. ```--tflite-delegate```, ```--tflite-parser```, ```--onnx-parser```) must be provided or else provide ```--all``` to build all Arm NN components.<br> @@ -181,10 +181,10 @@ Build for aarch64 with all Arm NN components, NEON enabled and OpenCL enabled:<b ```BUILD_ARGS="--target-arch=aarch64 --all --neon-backend --cl-backend"``` Build for aarch64 with TF Lite Delegate, OpenCL enabled and additional ACL scons params:<br> -```BUILD_ARGS="--target-arch=aarch64 --tflite-delegate --cl-backend --acl-scons-params='compress_kernels=1 benchmark_examples=1'"``` +```BUILD_ARGS="--target-arch=aarch64 --tflite-delegate --cl-backend --acl-scons-params='compress_kernels=1,benchmark_examples=1'"``` Setup for aarch64 with all Arm NN dependencies, OpenCL enabled and additional Arm NN cmake args:<br> -```BUILD_ARGS="--target-arch=aarch64 --all --cl-backend --armnn-cmake-args='-DBUILD_SAMPLE_APP=1 -DBUILD_UNIT_TESTS=0'"``` +```BUILD_ARGS="--target-arch=aarch64 --all --cl-backend --armnn-cmake-args='-DBUILD_SAMPLE_APP=1,-DBUILD_UNIT_TESTS=0'"``` **Example _valid_ combination of SETUP_ARGS and BUILD_ARGS:**<br> ``` |