diff options
author | Isabella Gottardi <isabella.gottardi@arm.com> | 2021-04-20 14:08:52 +0100 |
---|---|---|
committer | Isabella Gottardi <isabella.gottardi@arm.com> | 2021-04-23 17:52:15 +0100 |
commit | 8520983b8e73bf25826fab4cc99fc656b11fabc0 (patch) | |
tree | 5cf071084c567b0e013215261538e235a6568f45 /docs/sections | |
parent | b88705d6c04d8b7b2fdffaf1501042b984e682cf (diff) | |
download | ml-embedded-evaluation-kit-8520983b8e73bf25826fab4cc99fc656b11fabc0.tar.gz |
MLECO-1871: Adding external use-case directories support
* Cmake updates
* Markdownlint on docs
* Removing windows command leftovers
Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
Change-Id: I4a12b4e798559e8f4e8a3307038df7829137184a
Diffstat (limited to 'docs/sections')
-rw-r--r-- | docs/sections/appendix.md | 2 | ||||
-rw-r--r-- | docs/sections/building.md | 23 | ||||
-rw-r--r-- | docs/sections/coding_guidelines.md | 2 | ||||
-rw-r--r-- | docs/sections/customizing.md | 2 | ||||
-rw-r--r-- | docs/sections/deployment.md | 3 | ||||
-rw-r--r-- | docs/sections/run.md | 2 | ||||
-rw-r--r-- | docs/sections/testing_benchmarking.md | 2 | ||||
-rw-r--r-- | docs/sections/troubleshooting.md | 2 |
8 files changed, 13 insertions, 25 deletions
diff --git a/docs/sections/appendix.md b/docs/sections/appendix.md index 7b56faa..fe8e85d 100644 --- a/docs/sections/appendix.md +++ b/docs/sections/appendix.md @@ -17,4 +17,4 @@ The table below is the memory mapping information specific to the Arm® Cortex® | SRAM | 0x3100_0000 | 0x313F_FFFF | 4 MiB | S | 2 banks of 2 MiB each as SSE-300 internal SRAM region | | DDR | 0x7000_0000 | 0x7FFF_FFFF | 256 MiB | S | DDR memory region | -Default memory map can be found here: https://developer.arm.com/documentation/101051/0002/Memory-model/Memory-map
\ No newline at end of file +Default memory map can be found here: <https://developer.arm.com/documentation/101051/0002/Memory-model/Memory-map>. diff --git a/docs/sections/building.md b/docs/sections/building.md index a5c9aff..6241286 100644 --- a/docs/sections/building.md +++ b/docs/sections/building.md @@ -341,16 +341,6 @@ cmake \ -DCMAKE_TOOLCHAIN_FILE=scripts/cmake/bare-metal-toolchain.cmake .. ``` -for Windows add `-G "MinGW Makefiles"`: - -```commandline -cmake \ - -DTARGET_PLATFORM=mps3 \ - -DTARGET_SUBSYSTEM=sse-200 \ - -DCMAKE_TOOLCHAIN_FILE=scripts/cmake/bare-metal-toolchain.cmake \ - -G "MinGW Makefiles .. -``` - ### Configuring native unit-test build ```commandline @@ -358,6 +348,7 @@ cmake \ -DTARGET_PLATFORM=native \ -DCMAKE_TOOLCHAIN_FILE=scripts/cmake/native-toolchain.cmake .. ``` + Results of the build will be placed under `build/bin/` folder: ```tree @@ -374,15 +365,6 @@ cmake \ -DCMAKE_TOOLCHAIN_FILE=scripts/cmake/bare-metal-toolchain.cmake .. ``` -For Windows add `-G "MinGW Makefiles"`: - -```commandline -cmake \ - -DTARGET_PLATFORM=simple_platform \ - -DCMAKE_TOOLCHAIN_FILE=scripts/cmake/bare-metal-toolchain.cmake \ - -G "MinGW Makefiles" .. -``` - ### Building the configured project If the CMake command succeeds, build the application as follows: @@ -602,9 +584,6 @@ cmake \ ``` > **Note:** For the specific use case command see the relative section in the use case documentation. - -For Windows, add `-G MinGW Makefiles` to the CMake command. - > **Note:** Clean the build directory before re-running the CMake command. The TensorFlow Lite for Microcontrollers model pointed to by `<use_case>_MODEL_TFLITE_PATH` and diff --git a/docs/sections/coding_guidelines.md b/docs/sections/coding_guidelines.md index f1813d3..752fe54 100644 --- a/docs/sections/coding_guidelines.md +++ b/docs/sections/coding_guidelines.md @@ -292,7 +292,7 @@ by other people. > **Note:** Leave one blank line between each of these groups for readability. >Use quotes for headers from within the same project and angle brackets for third-party and system headers. >Do not use paths relative to the current source file, such as `../Header.hpp`. Instead configure your include paths ->in the project makefiles. + >in the project makefiles. ```C++ #include "ExampleClass.hpp" // Own header diff --git a/docs/sections/customizing.md b/docs/sections/customizing.md index 841923b..323ffb5 100644 --- a/docs/sections/customizing.md +++ b/docs/sections/customizing.md @@ -1,5 +1,7 @@ # Implementing custom ML application +## Contents + - [Software project description](#software-project-description) - [HAL API](#hal-api) - [Main loop function](#main-loop-function) diff --git a/docs/sections/deployment.md b/docs/sections/deployment.md index 3d5796f..4c9101c 100644 --- a/docs/sections/deployment.md +++ b/docs/sections/deployment.md @@ -1,5 +1,7 @@ # Deployment +## Contents + - [Fixed Virtual Platform](#fixed-virtual-platform) - [Setting up the MPS3 Arm Corstone-300 FVP](#setting-up-the-mps3-arm-corstone-300-fvp) - [Deploying on an FVP emulating MPS3](#deploying-on-an-fvp-emulating-mps3) @@ -277,5 +279,4 @@ off. ... ``` - Next section of the main documentation, [Running code samples applications](../documentation.md#Running-code-samples-applications). diff --git a/docs/sections/run.md b/docs/sections/run.md index 90ee7c8..900101d 100644 --- a/docs/sections/run.md +++ b/docs/sections/run.md @@ -1,6 +1,8 @@ # Running Ethos-U55 Code Samples +## Contents + - [Starting Fast Model simulation](#starting-fast-model-simulation) This section covers the process for getting started with pre-built binaries for the Code Samples. diff --git a/docs/sections/testing_benchmarking.md b/docs/sections/testing_benchmarking.md index 0c7c675..e2ed434 100644 --- a/docs/sections/testing_benchmarking.md +++ b/docs/sections/testing_benchmarking.md @@ -1,5 +1,7 @@ # Testing and benchmarking +## Contents + - [Testing](#testing) - [Benchmarking](#benchmarking) diff --git a/docs/sections/troubleshooting.md b/docs/sections/troubleshooting.md index 40b975a..5e52a4e 100644 --- a/docs/sections/troubleshooting.md +++ b/docs/sections/troubleshooting.md @@ -1,5 +1,7 @@ # Troubleshooting +## Contents + - [Inference results are incorrect for my custom files](#inference-results-are-incorrect-for-my-custom-files) - [The application does not work with my custom model](#the-application-does-not-work-with-my-custom-model) |