summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2023-03-21MLECO-3802: [Maintenance] Remove Pillow warning23.02Isabella Gottardi
- Image.Resampling.BILINEAR replace deprecated Image.BILINEAR - Trivial documentation fixes Change-Id: Ia75af2d2bf171085d4a0a2c472f0e3f94dbdc5b9 Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2023-03-17MLECO-3842, MLECO-3801, MLECO-3899: Minor improvementsKshitij Sisodia
Some minor improvements in this patch: * Added notes on troubleshooting WSL2 build issues. * Fixed a stray guard for MPS3_PLATFORM from noise reduction use-case. * The default build script `build_default.py` will now return an error code to the calling process if it fails. Change-Id: I4557a402646fdf903b2cb043bf68d5d0b0d12972 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2023-02-13MLECO-2709: Inclusive language updateConor Kennedy
* Update various files to use inclusive language Signed-off-by: Conor Kennedy <conor.kennedy@arm.com> Change-Id: I538f61a400e1d58acb6397bb5e2ba3d912196314
2023-01-05MLECO-3677: Adding links for AN555 resources.Kshitij Sisodia
Minor documentation updates to add links for Arm Corstone-310 implementation `AN555`. Change-Id: I5fd1f577b0adcb1041aaefbc41d121ce52404e09 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-12-23MLECO-3748: Documentation updatesKshitij Sisodia
Added documentation around known issue with Arm GNU toolchain version 12.2.1. Minor change for MLECO-3731 also included. Link-time warnings for Arm GNU toolchain 11.3.1 also fixed. Change-Id: Ia8215e9f71327eeb59868aea91729d7b19dd6d34 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-12-19MLECO-3611: Formatting fixes for generated files.Kshitij Sisodia
Template files updated for generated files to adhere to coding guidelines and clang format configuration. There will still be unavoidable violations, but most of the others have been fixed. Change-Id: Ia03db40f8c62a369f2b07fe02eea65e41993a523 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-12-01MLECO-3620 MLECO-3619: Update to 22.11 dependencies22.11-rc122.11Richard Burton
* CMSIS-NN is now a seperate dependency * Added inclusive language commitment * TensorFlow Lite Micro dependency is moved ahead of 22.11 to fix compilation issue Change-Id: I60e3311ff7da2ce064cbcdca054a86bdd1f620d8
2022-11-17MLECO-3583: Update copyright notice according to new guidelinesRichard Burton
Change-Id: I0f057b33993e5196a60e52f4fb0c60e09693dcfe
2022-11-09MLECO-3247: Arm Corstone-310 deployment instructions updateKshitij Sisodia
Minor documentation updates for Corstone-310 target along with version bump for the project and updates to release notes. Change-Id: I8b33b66961ab0517864539d88501ad5d71219368 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-10-14MLECO-3562: Trivial documentation link updateKshitij Sisodia
Link update in docs/sections/building.md file. Change-Id: I6b4b95bc4c3e911123ee745e64fe6075af563011 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-10-12MLECO-3562: Add documentation on CMake PresetsMaksims Svecovs
Adds documentation on how to configure and use CMake Presets in VS Code. Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com> Change-Id: I0aa5d598415895268cabc9cbe36e7582a6fea789
2022-10-05MLECO-3065 Adding Git hook setup scriptEanna O Cathain
Change-Id: Ia900b17f13f1329b2788360e8dde639807f08099 Signed-off-by: Eanna O Cathain <eanna.ocathain@arm.com>
2022-10-03MLECO-3149: Add CTest driven FVP runs for non-native targets.Sarah Blades
Additional CMake configuration parameters required: * `BUILD_FVP_TESTS`: Selects whether these tests are built, OFF by default. * `FVP_PATH`: Path to the FVP that MUST be provided for the configuration to succeed. Change-Id: I741379cd0a6078a3e2c3163e6b253b2f5dc25c58 Signed-off-by: Sarah Blades <sarah.blades@arm.com>
2022-09-28MLECO-3518: Move to CMake 3.23.3Maksims Svecovs
For the purpose of using decoupled presets move required CMake version to 3.23.3 that supports "includes" option for presets. Updates the documentation. Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com> Change-Id: I259e8e3a4641294d8ccdee429c7284d8160b9e24
2022-09-26MLECO-3254 Default to using only one file per UCEanna O Cathain
Signed-off-by: Eanna O Cathain <eanna.ocathain@arm.com> Change-Id: I4a1cd2b5746cb479ae0d81ed973961cec2f3046e
2022-09-07MLECO-3535: update to 22.08 versions of modelsNina Drozd
* update to 22.08 release of ethos-u-vela * update download_dependencies script to new tf revision Signed-off-by: Nina Drozd <nina.drozd@arm.com> Change-Id: Ib4cb47ac0881d45fc6766b6b87154584d9db7374
2022-09-05MLECO-3538: Minor documentation updatesNina Drozd
* updated table of contents for building page * point to timing adapter page * updates to timing adapter page links and tables Change-Id: I54bde77db1a082afddae0abe109fa1369506057c
2022-08-31MLECO-3449: Update dependancies to 22.08 tagsMaksims Svecovs
Update dependencies to be aligned with 22.08 release of mlplatform according to: https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u/+/refs/heads/master/22.08.json CMSIS-DSP is moved to a separate repository, this patch adds a new repository along with user build parameter. Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com> Change-Id: I356fb19b5dac87a21adfc34c67f9699131666074
2022-08-25MLECO-3252: Minor documentation additionsKshitij Sisodia
Documentation md files added under source tree with links to the main docs. Minor updates to FAQs for MLECO-3251 as well. Change-Id: Ifdcc587f2fcf77228fd46e211d3f9c3963bc9b97 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-08-16MLECO-3321: Updated TensorFlow Lite Micro.Kshitij Sisodia
Updated to latest version of TensorFlow Lite Micro and removed forcing TENSORFLOW_LITE_MICRO_TARGET_ARCH to Arm Cortex-M55 for SSE-310 (now it is correctly set to Cortex-M85 instead). Change-Id: Ib1e8680a8d2ea803e0e003032119a10b1d71754e Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-08-16MLECO-3319: Documentation updates for Arm® Corstone™-310.Kshitij Sisodia
Documentation updates around use of Arm® Corstone™-310 AVH, especially in terms of use of timing adapters (TA). Also, use of TA's is forced off for SSE-310 subsystem's CMake configuration. Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com> Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com> Change-Id: I66a87060d8d47ce2580aa15f3908be20162eab54
2022-08-16MLECO-3244: Documentation on timing adaptersMaksims Svecovs
Documents current differences between timing adapters implementations on Corstone-300 and Corstone-310 platforms. Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com> Change-Id: I3161dc929bd01217a4992be869f13377a58e5471
2022-08-05MLECO-3232: Add basic cmake presetsMaksims Svecovs
Assuming cmake 3.21 adds basic configuration and build presets: * Target mps3 board with gcc * Target mps3 board with armclang * Target simple platform with gcc * Target simple platform with armclang * Target native build system Adds test preset for native build to run default ctests. Adds respective doc section to building instructions. Note: hidden configurationPresets are to be moved to respective project directories once cmake 3.24 is supported in the codebase and preset include is supported. Note: it is encouraged to create a personal CMakeUserPresets.json with personal preferences like specific `LOG_LEVEL` and `jobs` for faster compilation time. Usage example: cmake --preset=mps3-gcc Signed-off-by: Maksims Svecovs <maksims.svecovs@arm.com> Change-Id: I07a8861ed91160cc3f5167e16be45a921b60a285
2022-08-03MLECO-3375: Update documentation for missing AVH python3.8 venv packageRichard Burton
Change-Id: Idfee5b33b31cabdf7e825c2161df1e71191d115a
2022-06-29MLECO-3253 Adding docs for how to run the FVP without UIEanna O Cathain
Change-Id: I3e69514aac22973f5c2395371f1311bd5bbb83a3
2022-06-02MLECO-3148 Enabling Ctest driven testingEanna O Cathain
Signed-off-by: Eanna O Cathain <eanna.ocathain@arm.com> Change-Id: Ica67662d20b0c02b75418f79d4ba2f4d18373310
2022-06-01MLECO-2968 Create a docker image with all requirementsKshitij Sisodia
Added a Dockerfile to setup and install requirements for the ml-embedded-evaluation-kit repository. Also included minor change (MLCE-859) for NPU components' source file. Signed-off-by: Matthew Sloyan <matthew.sloyan@arm.com> Change-Id: I621fb2991218a451a0e8c33e14032b9c9e36709e
2022-05-31MLECO-3213: Downgrade requirment from Python3.8 to Python3.7Richard Burton
Update Vela to 3.4.0 Signed-off-by: Richard Burton <richard.burton@arm.com> Change-Id: If203d29d6884219cd4947a5753a1fb8d8284f174
2022-05-25MLECO-3185: Documentation updatesKshitij Sisodia
Documentation updated to reflect refactoring changes in the last few weeks. Change-Id: Ic7abf5cc3af9898123049e890c189ed74e505309
2022-05-24MLECO-3188: update AVH documentationNina Drozd
* update to Arm Virtual Hardware link Change-Id: If93d20e32b32ff4d6bcfa8f0e0ef096f3fff9492
2022-05-23MLECO-3225: Using official support for Arm Cortex-M85 CPU.Kshitij Sisodia
* CMake version requirement bumped up to 3.21.0 * CMake 3.22.4 installed in the local Python virtualenv * CPU flags updated in toolchain files. * Using __ARM_FEATURE_DSP instead of potentially defining ARM_MATH_DSP wrongly. * CMake project version bumped up to 22.05.0 Changes also made for MLECO-3107 (pack generation): * TensorFlow Lite Micro CMSIS-pack version updated to 1.22.02. * Change to using __ARM_FEATURE_DSP will also help the generated pack. Partial changes for MLECO-3095: * CMSIS updated to version post 5.9.0 * TensorFlow Lite Micro updated to latest available * Ethos-U driver and core-platform repositories updated to 20.05_rc2 tags. Change-Id: I012c9e65897aed8ce589cff9bfe3a19efc3edeb9 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-05-17MLECO-2985 Adding Corstone-310 supportKshitij Sisodia
Change-Id: Ifa4b11154478355c10cb3e747b9938a74afd242b Signed-off-by: Eanna O Cathain <eanna.ocathain@arm.com>
2022-05-12MLECO-3186: Each use case should same namespace convention as KWS and ASRLiam Barry
Certain UCs required additional work due to case context variables which also became part of a namespace in generated files. Solution was to declare these extra variables as part of the UC namespace in the respective model.hpp files. Additional changes to standardise use of namespaces may be required - proposing new task. Minor typo and rewording of customizing.md in relevant sections included. Signed-off-by: Liam Barry <liam.barry@arm.com> Change-Id: Ie78f82a30be252cb841136ea5115f21fc8d762cb
2022-05-10MLECO-3160 Adding .clang-formatEanna O Cathain
Change-Id: If5cf20e189273a887917aefcc745c4992be93e1d Reviewed-on: https://eu-gerrit-2.euhpc.arm.com/c/ml/ecosystem/ml-embedded-evaluation-kit/+/543186 Tested-by: mlecosys <mlecosys@arm.com> Reviewed-by: Nina Drozd <nina.drozd@arm.com> Reviewed-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-05-06MLECO-3183: Refactoring application sourcesKshitij Sisodia
Platform agnostic application sources are moved into application api module with their own independent CMake projects. Changes for MLECO-3080 also included - they create CMake projects individial API's (again, platform agnostic) that dependent on the common logic. The API for KWS_API "joint" API has been removed and now the use case relies on individual KWS, and ASR API libraries. Change-Id: I1f7748dc767abb3904634a04e0991b74ac7b756d Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-04-08MLECO-3070: Further HAL cleanup.Kshitij Sisodia
Cleaning up HAL sources by removing unnecessary redirections with function pointers. The "platform packages" under HAL are now streamlined enough to not need any major HAL wrapping (as was the case before). This allows us to have a very thin HAL layer that sits on top of the platform and compnent packs. Also helps in getting rid of "hal platform" pointer being passed around in the code to use any HAL functionality. Change-Id: I04b2057f972aad7a5cfb4a396bcdf147c9f9ef1c Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-04-06MLECO-3096: Removing data_acq and data_psnKshitij Sisodia
Further to the HAL refactoring done in previous commits, this CR simpifies HAL by removing data_acq and data_psn "modules". The associated function pointers have been removed. Change-Id: I04c194c08dfe0aff98ce4e0f0f056bac254c137d Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-04-05MLECO-3096: Removing "timer" from HAL profile.Kshitij Sisodia
Attempting to have timer functionality contained within the platform drivers "package" as it should (in line with the refactoring work done so far under HAL). This will ensure that we don't need two timer implementations under HAL "profiles" and therefore, this whole directory can be removed. This change also addressed issue with the applicatio level Profiler code knowing about how the PMU has been set up by the platform code. This link has been removed completely. This will make it much easier to add/amend the Ethos-U PMU event counters types and give each platform the capability of populating their relvant counters. The application level Profiler doesn't know which metrics it is displaying but just calculates and maintains statistics for whatever PMU counters it receives from the HAL level. A fix for timing adapter issue introduced in the last CR is also included. Change-Id: Ia46e03a06e7b8e42b9ed2ba8f2af2dcd2229c110 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-03-28MLECO-2917 Replacing platform CMake definitions with headersKshitij Sisodia
Moving away from CMake description of targets and generation of platform header files (for memory addresses and IRQ numbers). Instead these headers are part of the repository under their respective platform-driver packages under HAL sources. Change-Id: I9bd3e68eb17385f8b93eb3d8d76b212ce0e1a6d5 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-03-18MLECO-2999: Minor improvement for HAL NPU componentKshitij Sisodia
Dcoumentation updates in line with recent refactoring and some minor update to the HAL's NPU component. Change-Id: Iadb34dbcdedf7259f786c42bd8fcf2d950a51410 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2022-03-16MLECO-2919: Improvements for documentation.Kshitij Sisodia
Corrections and improvements in the build graph (documentation). Change-Id: Ic7f9afe587978f835a88109c21a4145b91daf45d
2022-03-15MLECO-2919: Updating build graph in docs.Kshitij Sisodia
Update to the build graph image in documentation for changes made in commit c22e80e (MLECO-2919). Change-Id: I16a5c4b11979d13010454d2f827e4ed3ca6cf5c3
2022-03-15MLECO-3035: [Documentation] Add instructions for updating to python3.8 for ↵Isabella Gottardi
Ubuntu 18.04 (or older) users Change-Id: If7bb02f44f8bb7b84b7b7a620e69429a7b5fbb60 Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2022-03-15MLECO-3041: Update model optimization documentationRichard Burton
Change-Id: I771089443a6cdb4135570fcdd6e321a8f68fcf4a
2022-03-14MLECO-2919: Restructuring to standardise HAL APIsKshitij Sisodia
* LCD module component created (removed from individual platform packs). * retarget.c moved out into its own component that wraps the uart module. It also have the native stub for GetLine => paved the way for removing data_acq module from profiles. * shortened names for components' dir for npu and ta * remove peripheral_memmap and peripheral_irqs headers from platform_drivers.h. There should be no need for these to be included in the top level now. These should be private headers. * cmsis_device moved in as a component. * Pyenv created by set_up_default_resource.py will also install packages that CMake's source generator needs. TODO's: * Remove timer from profiles (MLECO-3096) Change-Id: I9d6ea2f4f291788f40a16ed507019563c8d7f205
2022-03-11MLECO-3006: Fixing some minor errors in documentationIsabella Gottardi
Change-Id: I24cd544780f46fcec8f154b440f7bb959c20a459 Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2022-03-09MLECO-3010 Minor clarifications in quick start guideLiam Barry
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>
2022-03-04Minor fix in documentation22.02-rc122.02Isabella Gottardi
Change-Id: I958aa912d135241743c95a4ece81bb6deee22006
2022-03-04MLECO-2984: Refactor componentsKshitij Sisodia
* Use UART component from Ethos-U core-platform * Components as cmake project Change-Id: I053f3a59800abc20216e6a4df8555db357e3f21d Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2022-03-04MLECO-2978: Update to 22.02 dependenciesRichard Burton
* Core-platform now a depdenency for timing adapter Signed-off-by: Richard Burton <richard.burton@arm.com> Change-Id: I54f3773bdf91083fa1513be15372fcf2231bea2c
generated by cgit v1.2.1 (git 2.23.0) at 2024-07-24 12:19:25 +0000