summaryrefslogtreecommitdiff
path: root/docs/documentation.md
AgeCommit message (Collapse)Author
2024-05-15Minor documentation fixesKshitij 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>
2024-05-03MLECO-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-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-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-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-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-05-25MLECO-3185: Documentation updatesKshitij Sisodia
Documentation updated to reflect refactoring changes in the last few weeks. Change-Id: Ic7abf5cc3af9898123049e890c189ed74e505309
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-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-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-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-02-25Documentation fixesIsabella Gottardi
Change-Id: I2036332cffee94f1a3b69b391586d0a2f6c9db55
2022-02-24MLECO-2925: updated documentation with new repo structure and general ↵alexander
guidance to add custom platform. Signed-off-by: alexander <alexander.efremov@arm.com> Change-Id: Ib2eb2b7460c0ee8161403e5b135cd8b5cd854334
2022-02-15MLECO-2614: Minor documentation updatesIsabella Gottardi
* Adding troubleshooting for cloning errors Change-Id: Ib57353900064c68c30ecb2141602081180c50c99 Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2021-12-24MLECO-2599: Replace DSCNN with MicroNet for KWSKshitij Sisodia
Added SoftMax function to Mathutils to allow MicroNet to output probability as it does not nativelu have this layer. Minor refactoring to accommodate Softmax Calculations Extensive renaming and updating of documentation and resource download script. Added SoftMax function to Mathutils to allow MicroNet to output probability. Change-Id: I7cbbda1024d14b85c9ac1beea7ca8fbffd0b6eb5 Signed-off-by: Liam Barry <liam.barry@arm.com>
2021-11-25MLECO-2426: Support for new Corstone-300 app note AN552 rev B.Kshitij Sisodia
These changes will limit the use of FPGA internal SRAM from a max of 4MiB to 2MiB and the BRAM from 2MiB to 1MiB. Change-Id: I69c8e695aee26ff4f235bfe83ffd26efbd66f547
2021-11-16MLECO-2520: Change md files to have correct file linksCisco Cervellera
Change-Id: I3ec18583c321eb2815a670d56f4958e610331d6d
2021-11-10MLECO-2354 MLECO-2355 MLECO-2356: Moving noise reduction to public repositoryRichard Burton
* Use RNNoise model from PMZ * Add Noise reduction use-case Signed-off-by: Richard burton <richard.burton@arm.com> Change-Id: Ia8cc7ef102e22a5ff8bfbd3833594a4905a66057
2021-10-05MLECO-2395: Allow users to select Ethos-U memory modeIsabella Gottardi
Change-Id: Icf09410f12072e8d7850dd1e540c3243af24ed09
2021-09-16MLECO-2082: Adding visual wake word use case21.08Éanna Ó Catháin
MLECO-2083: Refactoring img_class and visual wake word *Added source files for visual wake word *Added tests *Added docs *Added new images for visual wake word demo *Refactored common functions in img_class, visual wake word and other usecases Change-Id: Ibd25854e19a5517f940a8d3086a5d4835fab89e9 Signed-off-by: Éanna Ó Catháin <eanna.ocathain@arm.com>
2021-09-15MLECO-2238: Add FAQ section to documentationIsabella Gottardi
Change-Id: I4dbab11223697c6c1405a3466fdbe87e9b23cf0d
2021-09-03MLECO-2235: Fix documentationIsabella Gottardi
Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com> Change-Id: If8d6bf60cd4961be4c29f46ea75422b093185b04
2021-08-13MLECO-1982: Update to using latest ethos-u embedded componentsIsabella Gottardi
Change-Id: I744a4eb2553207004c9403b956e5bd9e9b352bfb Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2021-08-06Fix documentation.Isabella Gottardi
* Fix broken link "building-for-different-ethos_u-npu-variants" * Corstone-300 + Ethos-U65 NPU support in memory_considerations Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com> Change-Id: I2e99e2d24d3cd0bb64e06481862660d1b0679f20
2021-08-03MLECO-2051: Work with Corstone-300 + Ethos-U65Cisco Cervellera
Change-Id: I64ab930a1de5210f435f91bed7600a700581946f Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com> Reviewed-on: https://eu-gerrit-2.euhpc.arm.com/c/ml/ecosystem/ml-embedded-evaluation-kit/+/459126 Tested-by: mlecosys <mlecosys@arm.com> Tested-by: George Gekov <george.gekov@arm.com> Reviewed-by: George Gekov <george.gekov@arm.com> Reviewed-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2021-06-10MLECO-1988: Add links to Ethos-U landing pagesGeorge Gekov
Change-Id: Id6788b3fdc8ffae9079c99e95c459c5aa4abda7a Signed-off-by: George Gekov <george.gekov@arm.com>
2021-06-02MLECO-1901: Document MAC config mismatch errorGeorge Gekov
Change-Id: I9b6b63724d136f36f57a9402059327f8fab27bf1 Signed-off-by: George Gekov <george.gekov@arm.com>
2021-05-28MLECO-1943: Fixing documentation linksKshitij Sisodia
Couple of minor links fixed for documentation.md. Change-Id: I4309bf83d8bc4c818a2d96bb54b3e0ecdfc27e4b
2021-05-27MLECO-1943: Documentation reviewKshitij Sisodia
Major update for the documentation. Also, a minor logging change in helper scripts. Change-Id: Ia79f78a45c9fa2d139418fbc0ca9e52245704ba3
2021-05-25MLECO-1944: Minor documentation clean-up done and script to download TPIP added21.05-rc1alexander
Signed-off-by: alexander <alexander.efremov@arm.com> Change-Id: Id4a9b220ce753a5ecf3483e86d837c1814dc7fb9
2021-05-20MLECO-1883: Updating wav2letter modelKshitij Sisodia
Using the new pruned wav2letter model from Arm Model Zoo. The new model when optimised by Vela, produces a tflite file ~10 MB smaller than the current. Change-Id: I4ab6007c5b6111f41d8097e29b2af6cde2abc457
2021-05-19MLECO-1913: Documentation update: helper scripts and AD use case model updateIsabella Gottardi
Change-Id: I610b720146b520fe8633d25255b97df647b99ef5 Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
2021-05-18MLECO-1858: Documentation updateIsabella Gottardi
* Removing `_` in front of private functions and member Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com> Change-Id: I5a5d652f9647ebb16d2d2bd16ab980e73f7be3cf
2021-05-07MLECO-1860: Support for Arm GNU Embedded ToolchainKshitij Sisodia
This patch enables compilation of ML use cases bare-metal applications using Arm GNU Embedded Toolchain. The GNU toolchain can be used instead of the Arm Compiler that was already supported. The GNU toolchain is also set as the default toolchain when building applications for the MPS3 target. Note: The version of GNU toolchain must be 10.2.1 or higher. Change-Id: I5fff242f0f52d2db6c75d292f9fa990df1aec978 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
2021-05-06MLECO-1898: removing support of legacy sse-200 platformalexander
Signed-off-by: alexander <alexander.efremov@arm.com> Change-Id: Ie462e786af1d429bcb815f2c10656ed82862715a
2021-04-29MLECO-1891: Document memory considerationsKshitij Sisodia
Change-Id: I8d775cbd5372d1142244daf6877355a3d5417a9e Signed-off-by: George Gekov <george.gekov@arm.com>
2021-04-23MLECO-1871: Adding external use-case directories supportIsabella Gottardi
* Cmake updates * Markdownlint on docs * Removing windows command leftovers Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com> Change-Id: I4a12b4e798559e8f4e8a3307038df7829137184a
2021-04-15 Windows support was removed from documentation.alexander
TensorFlow Lite micro build is not compatible with MinGW make. Signed-off-by: alexander <alexander.efremov@arm.com> Change-Id: I0980838f659431b18ebc54ec0a1e4371941c36b4
2021-04-07MLECO-1869: Documentation updatesalexander
* fixing simple_platform and native build commands in the docs. * Added link to a public forum * table of contents fixed * Minor doc pages refactoring related to TM * updated API img Change-Id: Ibf703d9e51084daeab1c3263f996008523250236
2021-03-29Opensource ML embedded evaluation kit21.03alexander
Change-Id: I12e807f19f5cacad7cef82572b6dd48252fd61fd
generated by cgit v1.2.1 (git 2.23.0) at 2024-06-03 19:26:08 +0000