Skip to content

Commit f900ea3

Browse files
authored
Merge pull request #8 from ReinhardKeil/main
Doc improvements, cleanup, DWARF-5 added to csolution.yml
2 parents 093d0c7 + 6b729fc commit f900ea3

17 files changed

+88
-53
lines changed

.vscode/settings.json

Lines changed: 0 additions & 5 deletions
This file was deleted.

ARM.CMSIS-MLEK.pdsc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<package schemaVersion="1.7.40" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="https://raw.githubusercontent.com/Open-CMSIS-Pack/Open-CMSIS-Pack-Spec/v1.7.40/schema/PACK.xsd">
33
<vendor>ARM</vendor>
4-
<name>CMSIS-MLEK</name>
5-
<description overview="overview/README.md">MLEK (Machine Learning Evaluation Kit) for CMSIS workflows</description>
4+
<name>cmsis-mlek</name>
5+
<description overview="overview/README.md">Machine Learning Evaluation Kit (MLEK) for CMSIS workflows</description>
66
<!-- web download link -->
77
<url>https://www.keil.com/pack/</url>
88
<license>LICENSE</license>

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Directory | Description
1818
----------------------------------|-------------------------------
1919
[overview](./overview) | Top-level overview of MLEK reference applications.
2020
[docs](./docs/) | Source of the [user documentation](https://arm-examples.github.io/cmsis-mlek) of the MLEK reference applications.
21-
[template](./template) | [MLEK reference applications](https://arm-examples.github.io/cmsis-mlek/main/template.html), a test framework for DSP and ML algorithms.
21+
[template](./template) | MLEK reference applications source code.
2222
[.github/workflows](./.github/workflows) | GitHub Actions for validation and publishing.
2323
[.ci](./.ci) | Files that relate to CI tests.
2424

2525
## Related
2626

27-
- [MLEK Pack](https://www.keil.arm.com/packs/MLEK) available on [keil.arm.com/packs](https://www.keil.arm.com/packs).
27+
- [CMSIS-MLEK Pack](https://www.keil.arm.com/packs/cmsis-mlek-arm) available on [keil.arm.com/packs](https://www.keil.arm.com/packs).
2828
- [tensorflow-lite-micro Pack](https://www.keil.arm.com/packs/tensorflow-lite-micro-tensorflow) available on [keil.arm.com/packs](https://www.keil.arm.com/packs).
2929
- [MLEK Examples](https://github.com/Arm-Examples/mlek-examples) a repository with MLEK applications that are configured for evaluation boards and use cases.
3030
- [ML Developers Guide for Cortex-M Processors and Ethos-U NPU](https://developer.arm.com/documentation/109267).
-33.3 KB
Loading

docs/images/KWS_preprocessing.png

52.9 KB
Loading

docs/images/SelectAVHTarget.png

-58.1 KB
Loading

docs/images/SelectMLEKTemplate.png

-51.7 KB
Loading

docs/images/kws_print.png

-122 KB
Loading

docs/index.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
1-
# CMSIS-MLEK Reference Application Package
1+
# Machine Learning Evaluation Kit (MLEK) for CMSIS Workflows
22

3-
This documentation explains the usage of the CMSIS-MLEK Reference Application Package for developing Machine Learning (ML) and Edge AI applications on Cortex-M processors with Ethos-U NPUs.
3+
This documentation explains the usage of the CMSIS-MLEK Reference Application Package for developing Machine Learning (ML) and Edge AI applications on Cortex-M processors optional with Ethos-U NPUs.
44

55
## Target Audience
66

77
This user's guide assumes basic knowledge about Cortex-M software development and CMSIS-Toolbox workflows. It is written for embedded software developers who work with C/C++ compiler toolchains and develop machine learning applications for microcontroller devices with Cortex-M processors and Ethos-U NPUs.
88

9+
## Manual Chapters
10+
11+
- [**Overview**](overview.md) explains the features and capabilities of the MLEK templates package.
12+
- [**MLEK Audio Applications**](templates_audio.md) describes the available ML templates for audio use-cases.
13+
- [**MLEK Video Applications**](templates_video.md) describes the available ML templates for video and image use-cases.
14+
- [**Targeting Hardware Boards**](target_configuration_refapp.md) gives step-by-step guidance for deploying the reference applications to a hardware platform in VS Code.
15+
- [**Targeting Arm Virtual Hardware**](target_configuration_avh.md) shows how to select a virtual target in Visual Studio code.
16+
17+
<!-- Duplicate of Overview.md
918
## Package Overview
1019
1120
The CMSIS-MLEK package provides ready-to-use templates and examples for machine learning applications. It includes three main template categories:
@@ -14,14 +23,6 @@ The CMSIS-MLEK package provides ready-to-use templates and examples for machine
1423
- **Video Reference Applications** - Object detection and video processing examples
1524
- **Generic Reference Applications** - General-purpose inference runner for custom ML models (available from version 1.0+)
1625
17-
## Manual Chapters
18-
19-
- [**Overview**](overview.md) explains the features and capabilities of the MLEK templates package.
20-
- [**MLEK Reference Applications - Audio**](templates_audio.md) describes the available ML templates for audio use-cases.
21-
- [**MLEK Reference Applications - Video**](templates_video.md) describes the available ML templates for video and image use-cases.
22-
- [**Target Configuration Reference Application Hardware**](target_configuration_refapp.md) gives step-by-step guidance for deploying the reference applications to a hardware platform in Visual Studion Code.
23-
- [**Target Configuration Arm Virtual Hardware**](target_configuration_avh.md) shows how to select a virtual target in Visual Studio code.
24-
2526
## Available Templates
2627
2728
The package includes the following example templates:
@@ -44,10 +45,10 @@ The templates support multiple Arm Cortex-M platforms:
4445
- **Corstone-320** (Cortex-M85 + Ethos-U85)
4546
4647
Each template can be built for both Arm Virtual Hardware (AVH) simulation and physical evaluation boards.
48+
-->
4749

4850
## Revision History
4951

5052
| Version | Description |
5153
|---------|-------------|
52-
| 0.1.0 | Initial draft release of CMSIS-MLEK templates package |
5354
| 0.5.0 | First published release. |

docs/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ The CMSIS-MLEK software pack is derived from the [Arm® ML embedded evaluation k
1414

1515
| ML application | Description | Neural Network Model |
1616
|:-----------------------------------------------|:------------------------|:----------------------|
17-
| [Keyword spotting (KWS)](https://github.com/ARM-software/cmsis-mlek/template/audio) | Recognize the presence of a key word in verbal speech | [MicroNet](https://github.com/ARM-software/ML-zoo/tree/9f506fe52b39df545f0e6c5ff9223f671bc5ae00/models/keyword_spotting/micronet_medium/tflite_int8) |
18-
| [Object detection](https://github.com/ARM-software/cmsis-mlek/template/video) | Detects and draws face bounding box in a given image | [Yolo Fastest](https://github.com/emza-vs/ModelZoo/blob/master/object_detection/yolo-fastest_192_face_v4.tflite) |
19-
| [Generic inference runner](https://github.com/ARM-software/cmsis-mlek/template/generic) | Code block allowing you to develop your own use case | Your custom model |
17+
| [Keyword spotting (KWS)](https://github.com/Arm-Examples/cmsis-mlek/template/audio) | Recognize the presence of a key word in verbal speech | [MicroNet](https://github.com/ARM-software/ML-zoo/tree/9f506fe52b39df545f0e6c5ff9223f671bc5ae00/models/keyword_spotting/micronet_medium/tflite_int8) |
18+
| [Object detection](https://github.com/Arm-Examples/cmsis-mlek/template/video) | Detects and draws face bounding box in a given image | [Yolo Fastest](https://github.com/emza-vs/ModelZoo/blob/master/object_detection/yolo-fastest_192_face_v4.tflite) |
19+
| [Generic inference runner](https://github.com/Arm-Examples/cmsis-mlek/template/generic) | Code block allowing you to develop your own use case | Your custom model |
2020

2121
Each [ML reference application](https://open-cmsis-pack.github.io/cmsis-toolbox/ReferenceApplications/) is a *csolution project* which supports deployment to physical hardware or Arm Virtual Hardware (AVH-FVP) for simulation.
2222

0 commit comments

Comments
 (0)