summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
6 hoursMinor documentation fixesHEADmainKshitij Sisodia
Minor fixes to broken links in markdown files. Added a note about timing adapters being disabled in Arm Corstone-315 by default. Change-Id: I7f0b33adc8c38e8be7a5bfcebbf5d87f4e22430c Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
8 daysMLECO-4935: Refactoring user optionsKshitij Sisodia
Refactoring for CMake configuration options to allow target platform to drive their own defaults for certain dependent options. For example, the MPS3 target platform defaults to SSE-300 sub-system while native target doesn't need to worry about sub-system and CMSIS options which it will never use. This allows MPS4 target to default to SSE-315 and set the NPU arch to Arm Ethos-U65 as it should, which otherwise would have had to be explictly specified by the user. A welcome by-product of this is also that the options summary at the end of a successful CMake configuration stage would only include the settings that are actually used by the given target. Change-Id: Ibb7f8233d427cd33f39eeb4c71d88193aa998ebd Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com> Tested-by: mlecosys <mlecosys@arm.com> Reviewed-by: Alex Tawse <alex.tawse@arm.com> Reviewed-by: Conor Kennedy <conor.kennedy@arm.com> Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
12 daysMLECO-4825: Adding Arm Corstone-315 supportKshitij Sisodia
This patch adds initial support for MPS4 based Arm Corstone-315 FVPs. The applications will execute on the FVP but with INITSVTOR set to `0x12000000` explicitly. The default value is the 64kiB code region at `0x11000000`. The linker scripts will be changed for the initial boot logic and vector table to be moved to the code region. This patch adds `source/hal/source/platform/mps4` directory. There is considerable overlap with MPS3 platform and this is expected to be the case until the support for MPS4 matures. Refactoring to pull in common bits from these targets will follow. Same goes for the CMake build support added under `scripts/cmake/platforms/mps4`. Change-Id: I981be9e1ec57cfedcf7d340b4f19e5eb40b5cbd3 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com> Tested-by: mlecosys <mlecosys@arm.com> Reviewed-by: Conor Kennedy <conor.kennedy@arm.com> Reviewed-by: Alex Tawse <alex.tawse@arm.com> Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2024-03-08MLECO-4732: Updating FVP versionKshitij Sisodia
Dockerfile updated for it to download the latest Fixed Virtual Platform (FVP) version 11.24. Minor documentation change to say that Arm Corstone-310 FVP is also available to download from the Arm Ecosystem FVP page. Change-Id: Icd19f71f53b4a6f1b912919e42e941fb23800d57 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2023-11-30MLECO-4371 Update dependencies to 23.11 release components23.11-rc1Richard Burton
* Updated NPU components and dependencies (core-driver, core-platform, Vela, CMSIS, TensorFlow Lite Micro) to 23.11 release SHAs. * Changed Python version to 3.10 * Updated release notes and other documentation * Added workarounds to scripts in order to address build issues Signed-off-by: Aron Virginas-Tar <aron.virginas-tar@arm.com> Change-Id: I0a639b80881b53eebb216085b7e6764e3be8ca67
2023-11-13Modifications to linker scriptsRichard Burton
* Change reference to all ops resolver * Added our own 'all ops resolver' * Move Labels objects out of BRAM for simple_platform * Minor fixes to documentation Signed-off-by: Richard Burton <richard.burton@arm.com> Change-Id: I8b0d66ce83287f2bc027cfc36a1f378c97755481
2023-11-08MLECO-3250 Eval Kit README refreshAyaan Masood
* Simplified the landing README file * Rearranged sections for improved reading flow Signed-off-by: Ayaan Masood <Ayaan.Masood@arm.com> Change-Id: I050b39d1acdb08626134e66af2ce2eee1dbffbf9
2023-11-03MLECO-3640 MLECO-3678: Adding support for M85 in GCCRichard Burton
Signed-off-by: Richard Burton <richard.burton@arm.com> Change-Id: I087e23f43b41fa0ef97ec7dcaeba807f6cba17e7
2023-09-05MLECO-4074: bump up version of armclang to 6.1923.08-rc223.08Nina Drozd
* issues identified with armclang 6.17 and 6.18 * updates in cmake for minimum version * updates in release notes and documentation Change-Id: Iffa711d9d95a509f5c07cd55f59a49bdcf3e9d6a
2023-08-31MLECO-4072: update MLEK dependencies to 23.08Nina Drozd
* version updates in cmakelists file * update submodules to 23.08 versions * updates to documentation - vela 3.9.0 Change-Id: I5e24d5729ecbd2289b04fcc845fb44f455ab38d5 Signed-off-by: Nina Drozd <nina.drozd@arm.com>
2023-06-22Small fixes based on feedbackRichard Burton
* Typo fix in documentation * Fix bug with build_default.py and passing in --make-verbose * Added additional requirement for third-party dependencies Signed-off-by: Richard Burton <richard.burton@arm.com> Change-Id: Icdac7d4583c4fe3000fe9bc784979b2d1cf70909
2023-06-09MLECO-4065: Revising scripts to use Python3.923.05Kshitij Sisodia
Revising documentation and scripts to use Python3.9 explicitly to remove the need for installing it system-wide that might break a distro's desktop and pacakge manager utilities. Change-Id: I683b55dd0243d0a726dc94eba2431005d4897c8c Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2023-05-30MLECO-4065 MLECO-4066: Updating to 23.05 dependenciesRichard Burton
* Update dependencies to 23.05 versions * Fix for a break caused by changes in TensorFlow Lite Micro * Update release notes Signed-off-by: Richard Burton <richard.burton@arm.com> Change-Id: Id2f60ea574aab982911125bdcb513adb8edc723d
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>
generated by cgit v1.2.1 (git 2.23.0) at 2024-05-15 19:48:56 +0000