diff options
| author | Liam Barry <liam.barry@arm.com> | 2022-03-03 10:50:40 +0000 |
|---|---|---|
| committer | Liam Barry <liam.barry@arm.com> | 2022-03-09 14:29:48 +0000 |
| commit | e7f512592818574d98c4b3ba09b4d3315fe025bd (patch) | |
| tree | 360ccc81331583c6f7a5c06cb319c02fa6e732e4 /docs/quick_start.md | |
| parent | e77e001d2e6123e62f8e65c0e45d8d0c2dd7c3f5 (diff) | |
| download | ml-embedded-evaluation-kit-e7f512592818574d98c4b3ba09b4d3315fe025bd.tar.gz | |
MLECO-3010 Minor clarifications in quick start guide
Tried to clarify location of axf file and need to change directory at a specific step
Added note on changing permissions to AVH guide and added link to AVH guide in
quickstart.md as well as recommending a VNC viewer if using AVH
Change-Id: I653f0ac3ae52a6fc1c44e28024b9513af89c6db6
Signed-off-by: Liam Barry <liam.barry@arm.com>
Diffstat (limited to 'docs/quick_start.md')
| -rw-r--r-- | docs/quick_start.md | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/quick_start.md b/docs/quick_start.md index 9808e15..dc8df50 100644 --- a/docs/quick_start.md +++ b/docs/quick_start.md @@ -6,6 +6,9 @@ The aim of this quick start guide is to enable you to run an application quickly This documentation assumes that you are using an Arm® *Ethos™-U55* NPU, it is configured to use 128 Multiply-Accumulate units, and is sharing SRAM with the Arm® *Cortex®-M55*. +The FVP is also available via Arm Virtual Hardware (AVH) hosted on AWS. This quick start guide can also be executed on an AVH instance +but requires creation of an AWS account and basic configuration outlined [here](./arm_virtual_hardware.md). + To get started quickly, please follow these steps: 1. First, verify that you have installed [the required prerequisites](sections/building.md#Build-prerequisites). @@ -47,14 +50,19 @@ To get started quickly, please follow these steps: 5. Launch the project as explained in the following section: [Deployments](sections/deployment.md#Deployment). In quick start guide, we use the keyword spotting application and the FVP. - Point the generated `bin/ethos-u-kws.axf` file, from step four, to the FVP you downloaded when installing the - prerequisites. Now use the following command: + Change directory to generated cmake build folder which contains the .axf file output from step 4 in it's `bin` + subdirectory. Launch the application by passing the axf to the FVP you downloaded when installing the prerequisites. + Alternatively, from the root directory add `<cmake-build-your_config>` to the path to the axf and use one of the + following commands: ```commandline - <path_to_FVP>/FVP_Corstone_SSE-300_Ethos-U55 -a ./bin/ethos-u-kws.axf + From auto-generated (or custom) build directory: + <path_to_FVP>/FVP_Corstone_SSE-300_Ethos-U55 -a ./bin/ethos-u-kws.axf + From root directory: + <path_to_FVP>/FVP_Corstone_SSE-300_Ethos-U55 -a <cmake-build-your_config>/bin/ethos-u-kws.axf ``` -6. A telnet window is launched through where you can interact with the application and obtain performance figures. +6. A telnet window is launched through which you can interact with the application and obtain performance figures. > **Note:** Executing the `build_default.py` script is equivalent to running the following commands: |