summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEanna O Cathain <eanna.ocathain@arm.com>2022-09-22 15:18:34 +0100
committerEanna O Cathain <eanna.ocathain@arm.com>2022-09-26 10:16:25 +0100
commit4c0ac91ef2b052eb57328b85edcb0071cb7558b2 (patch)
treebe057efcc32bd329ccce8f446a7213d923ee6761 /docs
parent27c5e3091ab3d5f6efd6407f0a44531e717ccd69 (diff)
downloadml-embedded-evaluation-kit-4c0ac91ef2b052eb57328b85edcb0071cb7558b2.tar.gz
MLECO-3254 Default to using only one file per UC
Signed-off-by: Eanna O Cathain <eanna.ocathain@arm.com> Change-Id: I4a1cd2b5746cb479ae0d81ed973961cec2f3046e
Diffstat (limited to 'docs')
-rw-r--r--docs/sections/building.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/sections/building.md b/docs/sections/building.md
index de78dce..bd6ae43 100644
--- a/docs/sections/building.md
+++ b/docs/sections/building.md
@@ -268,6 +268,9 @@ The build parameters are:
- `TENSORFLOW_LITE_MICRO_CLEAN_DOWNLOADS`: Optional parameter to enable wiping out `TPIP` downloads from TensorFlow
source tree prior to each build. Disabled by default.
+- `USE_SINGLE_INPUT`: Sets whether each use case will use a single default input file, or if a user menu is
+provided for the user to select which input file to use via a telnet window. Disabled by default.
+
For details on the specific use-case build options, follow the instructions in the use-case specific documentation.
Also, when setting any of the CMake configuration parameters that expect a directory, or file, path, **use absolute
@@ -457,6 +460,14 @@ cmake .. \
-DCMAKE_BUILD_TYPE=Debug
```
+#### Configuring to use default input data
+
+To configure the project to use default input data for each use case, you can use the following CMake option `USE_SINGLE_INPUT`.
+This will be set to `false` if not specified. Specifying it as `true` will result in each use case automatically running with predefined input data, thus removing the need for the user to use a telnet terminal to specify the input data. For Example:
+
+```commandline
+cmake ../ -DCMAKE_TOOLCHAIN_FILE=scripts/cmake/toolchains/bare-metal-armclang.cmake -DCMAKE_BUILD_TYPE=Debug -DUSE_SINGLE_INPUT=True
+```
#### Generating project for Arm Development Studio
To import the project into Arm Development Studio, add the Eclipse project generator and `CMAKE_ECLIPSE_VERSION` in the