summaryrefslogtreecommitdiff
path: root/docs/sections/testing_benchmarking.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/sections/testing_benchmarking.md')
-rw-r--r--docs/sections/testing_benchmarking.md42
1 files changed, 23 insertions, 19 deletions
diff --git a/docs/sections/testing_benchmarking.md b/docs/sections/testing_benchmarking.md
index 904f2c9..6350f52 100644
--- a/docs/sections/testing_benchmarking.md
+++ b/docs/sections/testing_benchmarking.md
@@ -1,11 +1,12 @@
# Testing and benchmarking
-- [Testing](#testing)
-- [Benchmarking](#benchmarking)
+- [Testing and benchmarking](#testing-and-benchmarking)
+ - [Testing](#testing)
+ - [Benchmarking](#benchmarking)
## Testing
-The `tests` folder has the following structure:
+The `tests` folder uses the following structure:
```tree
.
@@ -20,15 +21,15 @@ The `tests` folder has the following structure:
└── ...
```
-Where:
+The folders contain the following information:
-- `common`: contains tests for generic and common appplication functions.
-- `use_case`: contains all the use case specific tests in the respective folders.
-- `utils`: contains utilities sources used only within the tests.
+- `common`: The tests for generic and common appplication functions.
+- `use_case`: Every use-case specific test in their respective folders.
+- `utils`: Utility sources that are only used within the tests.
When [configuring](./building.md#configuring-the-build-native-unit-test) and
-[building](./building.md#building-the-configured-project) for `native` target platform results of the build will
-be placed under `<build folder>/bin/` folder, for example:
+[building](./building.md#building-the-configured-project) for your `native` target platform, the results of the build is
+placed under `<build folder>/bin/` folder. For example:
```tree
.
@@ -38,7 +39,7 @@ be placed under `<build folder>/bin/` folder, for example:
└── ethos-u-<usecase1>
```
-To execute unit-tests for a specific use-case in addition to the common tests:
+To execute unit-tests for a specific use-case, in addition to the common tests, use:
```commandline
arm_ml_embedded_evaluation_kit-<use_case>-tests
@@ -53,17 +54,20 @@ INFO - ARM Ethos-U55 Evaluation application for MPS3 FPGA Prototyping Board and
All tests passed (37 assertions in 7 test cases)
```
-Tests output could have `[ERROR]` messages, that's alright - they are coming from negative scenarios tests.
+> **Note:** Test outputs could contain `[ERROR]` messages. This is OK as they are coming from negative scenarios tests.
## Benchmarking
-Profiling is enabled by default when configuring the project. This will enable displaying:
+Profiling is enabled by default when configuring the project. Profiling enables you to display:
-- the active and idle NPU cycle counts when Arm® Ethos™-U55 is enabled (see `-DETHOS_U55_ENABLED` in
+- The active and idle NPU cycle counts when the Arm® *Ethos™-U55* is enabled. For more information, refer to the
+ `-DETHOS_U55_ENABLED` section in: [Build options](./building.md#build-options).
+- If CPU profiling is enabled, the CPU cycle counts and the time elapsed, in milliseconds, for inferences performed. For
+ further information, please refer to the `-DCPU_PROFILE_ENABLED` section in:
[Build options](./building.md#build-options).
-- CPU cycle counts and/or in milliseconds elapsed for inferences performed if CPU profiling is enabled
- (see `-DCPU_PROFILE_ENABLED` in [Build options](./building.md#build-options). This should be done only
- when running on a physical FPGA board as the FVP does not contain a cycle-approximate or cycle-accurate Cortex-M model.
+
+> **Note:** Only do this when running on a physical FPGA board as the FVP does not contain a cycle-approximate or
+> cycle-accurate *Cortex-M* model.
For example:
@@ -74,8 +78,8 @@ For example:
Idle NPU cycles: 702
```
-- For MPS3 platform, the time duration in milliseconds is also reported when `-DCPU_PROFILE_ENABLED=1` is added to
- CMake configuration command:
+- For the MPS3 platform, the time duration in milliseconds is also reported when `-DCPU_PROFILE_ENABLED=1` is added to
+ CMake configuration command, like so:
```log
Active NPU cycles: 5629033
@@ -84,4 +88,4 @@ For example:
Time in ms: 210
```
-Next section of the documentation: [Memory Considerations](memory_considerations.md).
+The next section of the documentation refers to: [Memory Considerations](memory_considerations.md).