blob: 3d814331811a20973f901af6d79e1d7e2bb9e006 [file] [log] [blame]
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +01001# yaml-language-server: $schema=https://raw.githubusercontent.com/Open-CMSIS-Pack/devtools/main/tools/packgen/schema/manifest.schema.json
2
3#----------------------------------------------------------------------------
4# Copyright (c) 2022 Arm Limited. All rights reserved.
5# SPDX-License-Identifier: Apache-2.0
6#
7# Licensed under the Apache License, Version 2.0 (the "License");
8# you may not use this file except in compliance with the License.
9# You may obtain a copy of the License at
10#
11# http://www.apache.org/licenses/LICENSE-2.0
12#
13# Unless required by applicable law or agreed to in writing, software
14# distributed under the License is distributed on an "AS IS" BASIS,
15# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16# See the License for the specific language governing permissions and
17# limitations under the License.
18#----------------------------------------------------------------------------
19
20# YML file to help generate a CMSIS pack for ml-embedded-eval-kit API.
21# See the CMakeLists.txt in the same directory to see the targets that
22# are included in the pack.
23#
24# Ideal usage: from the root of the repository
25#
Kshitij Sisodia9c6f9f82022-05-20 14:30:02 +010026# ml-embedded-eval-kit $ packgen -s ./ \ # Source dir (run this from repo root)
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010027# -v ./scripts/cmake/cmsis-pack-gen/use-case-api.yml \ # This file's path
Kshitij Sisodia1ec169b2022-06-01 09:06:21 +010028# -o <path-to>/ml-embedded-eval-kit-pack \ # Where to generate the output
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010029# -i <path-to>/tensorflow.tensorflow-lite-micro.pdsc \ # Tensorflow packs' PDSC file
30# -i <path-to>/ARM.CMSIS.pdsc \ # CMSIS packs' PDSC file
31#
32# The PDSC files are the ones extracted from the downloaded packs (and is optional).
33# packgen and packchk must be installed. See https://github.com/Open-CMSIS-Pack/devtools
34# on how to build these tools.
35
36build:
37 - name: "build-dir"
Kshitij Sisodia937052d2022-05-13 16:44:16 +010038 options: "cmake -DCMSIS_PACK_GEN_FLOW=ON"
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010039
40packs:
41 - name: "ml-embedded-eval-kit-uc-api"
Kshitij Sisodia8b0455c2022-10-03 09:22:56 +010042 description: "ML sample use case APIs derived from ml-embedded-eval-kit"
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010043 vendor: "ARM"
Kshitij Sisodia9c6f9f82022-05-20 14:30:02 +010044 license: "LICENSE_APACHE_2.0.txt"
Kshitij Sisodia9b835c72022-10-12 14:31:57 +010045 url: "https://git.mlplatform.org/ml/ethos-u/ml-embedded-evaluation-kit.git/plain/source/application/api/use_case/readme.md"
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010046
47 requirements:
48 packages:
Kshitij Sisodia8d03c192022-09-26 14:15:53 +010049 - attributes: {vendor: "tensorflow", name: "tensorflow-lite-micro", version: "1.22.5-rc4"}
50 - attributes: {vendor: "ARM", name: "CMSIS", version: "5.9.0"}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010051
52 releases:
Kshitij Sisodiadb7c5182022-09-27 10:45:12 +010053 - version: "22.8.0-Beta"
Kshitij Sisodia8b0455c2022-10-03 09:22:56 +010054 date: "2022-09-29"
Kshitij Sisodia9c6f9f82022-05-20 14:30:02 +010055 description: "Beta release package"
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010056
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010057 taxonomy:
Kshitij Sisodia8b0455c2022-10-03 09:22:56 +010058 - attributes: {Cclass: "ML Eval Kit", doc: "https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ml-embedded-evaluation-kit/+/refs/heads/main/Readme.md"}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010059 description: "A collection of end-to-end examples provided by Arm for Arm Cortex-M CPU and Arm Ethos-U NPU targets."
60
61 components:
62 - name: log
63 target: log
Nina Drozdaea0a6d2022-08-04 17:51:05 +010064 attributes: { Cclass: "ML Eval Kit", Cgroup: "Common", Csub: "Log", Cversion: "1.0.0" }
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010065 description: "Logging header-only utility"
Kshitij Sisodia8b0455c2022-10-03 09:22:56 +010066 files:
67 - name: "source/log/include/"
68 attributes: {category: include}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010069
70 - name: arm_math
71 target: arm_math
Nina Drozdaea0a6d2022-08-04 17:51:05 +010072 attributes: { Cclass: "ML Eval Kit", Cgroup: "Common", Csub: "Math", Cversion: "1.0.0" }
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010073 description: "Math function helpers dependent on CMSIS-DSP."
Kshitij Sisodia937052d2022-05-13 16:44:16 +010074 conditions:
75 - require: { Cclass: "CMSIS", Cgroup: "DSP"}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010076
77 - name: common_api
78 target: common_api
Nina Drozdaea0a6d2022-08-04 17:51:05 +010079 attributes: {Cclass: "ML Eval Kit", Cgroup: "Common", Csub: "API", Cversion: "1.0.0"}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010080 description: "Common API"
Kshitij Sisodia937052d2022-05-13 16:44:16 +010081 dependencies: ["arm_math", "log"]
82 conditions:
83 - require: { Cclass: "Machine Learning", Cgroup: "TensorFlow" }
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010084
85 - name: ad_api
86 target: ad_api
Nina Drozdaea0a6d2022-08-04 17:51:05 +010087 attributes: {Cclass: "ML Eval Kit", Cgroup: "Vibration", Csub: "Anomaly detection", Cversion: "1.0.0"}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010088 description: "Anomaly detection use case API."
89 dependencies: common_api
90
91 - name: asr_api
92 target: asr_api
Nina Drozdaea0a6d2022-08-04 17:51:05 +010093 attributes: {Cclass: "ML Eval Kit", Cgroup: "Voice", Csub: "Automatic speech recognition", Cversion: "1.0.0"}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +010094 description: "ASR use case API."
95 dependencies: common_api
96
97 - name: img_class_api
98 target: img_class_api
Nina Drozdaea0a6d2022-08-04 17:51:05 +010099 attributes: {Cclass: "ML Eval Kit", Cgroup: "Vision", Csub: "Image classification", Cversion: "1.0.0"}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +0100100 description: "Image classification use case API."
101 dependencies: common_api
102
103 - name: inference_runner_api
104 target: inference_runner_api
Kshitij Sisodia8d03c192022-09-26 14:15:53 +0100105 attributes: {Cclass: "ML Eval Kit", Cgroup: "Generic", Csub: "Inference runner", Cversion: "1.0.0"}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +0100106 description: "Generic inference runner use case API."
107 dependencies: common_api
108
109 - name: kws_api
110 target: kws_api
Nina Drozdaea0a6d2022-08-04 17:51:05 +0100111 attributes: {Cclass: "ML Eval Kit", Cgroup: "Voice", Csub: "Keyword spotting", Cversion: "1.0.0"}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +0100112 description: "KWS use case API."
113 dependencies: common_api
114
115 - name: noise_reduction_api
116 target: noise_reduction_api
Nina Drozdaea0a6d2022-08-04 17:51:05 +0100117 attributes: {Cclass: "ML Eval Kit", Cgroup: "Voice", Csub: "Noise reduction", Cversion: "1.0.0"}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +0100118 description: "RNN Noise use case API."
119 dependencies: common_api
120
121 - name: object_detection_api
122 target: object_detection_api
Nina Drozdaea0a6d2022-08-04 17:51:05 +0100123 attributes: {Cclass: "ML Eval Kit", Cgroup: "Vision", Csub: "Object detection", Cversion: "1.0.0"}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +0100124 description: "Object detection use case API."
125 dependencies: common_api
126
127 - name: vww_api
128 target: vww_api
Nina Drozdaea0a6d2022-08-04 17:51:05 +0100129 attributes: {Cclass: "ML Eval Kit", Cgroup: "Vision", Csub: "Person detection", Cversion: "1.0.0"}
Kshitij Sisodiaeb9dfa72022-05-09 11:35:24 +0100130 description: "Visual wake word use case API."
131 dependencies: common_api