diff options
Diffstat (limited to 'docs/use_cases/inference_runner.md')
-rw-r--r-- | docs/use_cases/inference_runner.md | 97 |
1 files changed, 23 insertions, 74 deletions
diff --git a/docs/use_cases/inference_runner.md b/docs/use_cases/inference_runner.md index ad47e7e..ebc4677 100644 --- a/docs/use_cases/inference_runner.md +++ b/docs/use_cases/inference_runner.md @@ -1,16 +1,16 @@ # Inference Runner Code Sample -- [Introduction](#introduction) - - [Prerequisites](#prerequisites) -- [Building the Code Samples application from sources](#building-the-code-samples-application-from-sources) - - [Build options](#build-options) - - [Build process](#build-process) - - [Add custom model](#add-custom-model) -- [Setting-up and running Ethos-U55 code sample](#setting-up-and-running-ethos-u55-code-sample) - - [Setting up the Ethos-U55 Fast Model](#setting-up-the-ethos-u55-fast-model) - - [Starting Fast Model simulation](#starting-fast-model-simulation) - - [Running Inference Runner](#running-inference-runner) -- [Inference Runner processing information](#inference-runner-processing-information) +- [Inference Runner Code Sample](#inference-runner-code-sample) + - [Introduction](#introduction) + - [Prerequisites](#prerequisites) + - [Building the Code Samples application from sources](#building-the-code-samples-application-from-sources) + - [Build options](#build-options) + - [Build process](#build-process) + - [Add custom model](#add-custom-model) + - [Setting-up and running Ethos-U55 code sample](#setting-up-and-running-ethos-u55-code-sample) + - [Setting up the Ethos-U55 Fast Model](#setting-up-the-ethos-u55-fast-model) + - [Starting Fast Model simulation](#starting-fast-model-simulation) + - [Running Inference Runner](#running-inference-runner) ## Introduction @@ -68,72 +68,23 @@ On Linux, execute the following command to build **only** Inference Runner appli Model when providing only the mandatory arguments for CMake configuration: ```commandline -cmake \ - -DTARGET_PLATFORM=mps3 \ - -DTARGET_SUBSYSTEM=sse-300 \ - -DCMAKE_TOOLCHAIN_FILE=./scripts/cmake/bare-metal-toolchain.cmake \ - -DUSE_CASE_BUILD=inference_runner .. +cmake ../ -DUSE_CASE_BUILD=inference_runner ``` - -Toolchain option `CMAKE_TOOLCHAIN_FILE` points to the toolchain specific file to set the compiler and platform specific -parameters. - To configure a build that can be debugged using Arm-DS, we can just specify -the build type as `Debug`: - -```commandline -cmake \ - -DTARGET_PLATFORM=mps3 \ - -DTARGET_SUBSYSTEM=sse-300 \ - -DCMAKE_TOOLCHAIN_FILE=scripts/cmake/bare-metal-toolchain.cmake \ - -DCMAKE_BUILD_TYPE=Debug \ - -DUSE_CASE_BUILD=inference_runner .. -``` - -To configure a build that can be debugged using a tool that only supports -DWARF format 3 (Modeldebugger for example), we can use: +the build type as `Debug` and use the `Arm Compiler` toolchain file: ```commandline -cmake \ - -DTARGET_PLATFORM=mps3 \ - -DTARGET_SUBSYSTEM=sse-300 \ - -DCMAKE_TOOLCHAIN_FILE=scripts/cmake/bare-metal-toolchain.cmake \ +cmake .. \ + -DCMAKE_TOOLCHAIN_FILE=scripts/cmake/toolchains/bare-metal-armclang.cmake \ -DCMAKE_BUILD_TYPE=Debug \ - -DARMCLANG_DEBUG_DWARF_LEVEL=3 \ - -DUSE_CASE_BUILD=inference_runner .. + -DUSE_CASE_BUILD=inference_runner ``` -> **Note:** If building for different Ethos-U55 configurations, see ->[Configuring build for different Arm Ethos-U55 configurations](../sections/building.md#Configuring-build-for-different-Arm-Ethos-U55-configurations): - -If the TensorFlow source tree is not in its default expected location, -set the path using `TENSORFLOW_SRC_PATH`. -Similarly, if the Ethos-U55 driver is not in the default location, -`ETHOS_U55_DRIVER_SRC_PATH` can be used to configure the location. For example: - -```commandline -cmake \ - -DTARGET_PLATFORM=mps3 \ - -DTARGET_SUBSYSTEM=sse-300 \ - -DCMAKE_TOOLCHAIN_FILE=scripts/cmake/bare-metal-toolchain.cmake \ - -DTENSORFLOW_SRC_PATH=/my/custom/location/tensorflow \ - -DETHOS_U55_DRIVER_SRC_PATH=/my/custom/location/core_driver \ - -DUSE_CASE_BUILD=inference_runner .. -``` - -Also, `CMSIS_SRC_PATH` parameter can be used to override the CMSIS sources used for compilation used by TensorFlow by -default. For example, to use the CMSIS sources fetched by the ethos-u helper script, we can use: - -```commandline -cmake \ - -DTARGET_PLATFORM=mps3 \ - -DTARGET_SUBSYSTEM=sse-300 \ - -DCMAKE_TOOLCHAIN_FILE=scripts/cmake/bare-metal-toolchain.cmake \ - -DTENSORFLOW_SRC_PATH=../ethos-u/core_software/tensorflow \ - -DETHOS_U55_DRIVER_SRC_PATH=../ethos-u/core_software/core_driver \ - -DCMSIS_SRC_PATH=../ethos-u/core_software/cmsis \ - -DUSE_CASE_BUILD=inference_runner .. -``` +Also see: +- [Configuring with custom TPIP dependencies](../sections/building.md#Configuring-with-custom-TPIP-dependencies) +- [Using Arm Compiler](../sections/building.md#using-arm-compiler) +- [Configuring the build for simple_platform](../sections/building.md#Configuring-the-build-for-simple_platform) +- [Working with model debugger from Arm FastModel Tools](../sections/building.md#Working-with-model-debugger-from-Arm-FastModel-Tools) > **Note:** If re-building with changed parameters values, it is highly advised to clean the build directory and re-run >the CMake command. @@ -188,11 +139,9 @@ Then, you must set `inference_runner_MODEL_TFLITE_PATH` to the location of the V An example: ```commandline -cmake \ +cmake .. \ -Dinference_runner_MODEL_TFLITE_PATH=<path/to/custom_model_after_vela.tflite> \ - -DTARGET_PLATFORM=mps3 \ - -DTARGET_SUBSYSTEM=sse-300 \ - -DCMAKE_TOOLCHAIN_FILE=scripts/cmake/bare-metal-toolchain.cmake .. + -DUSE_CASE_BUILD=inference_runner ``` > **Note:** Clean the build directory before re-running the CMake command. |