diff options
| author | Kshitij Sisodia <kshitij.sisodia@arm.com> | 2022-08-18 12:54:34 +0100 |
|---|---|---|
| committer | Nina Drozd <nina.drozd@arm.com> | 2022-08-25 14:32:02 +0000 |
| commit | c9f1717d227e21ebfab72cceee90b1f8f8522867 (patch) | |
| tree | 991e1cb1b921f4cbe6cc88edc1797eb0eafba4cc /source/application | |
| parent | 271c69e8e364361f3e4c839a10a4f29ef4c9c866 (diff) | |
| download | ml-embedded-evaluation-kit-c9f1717d227e21ebfab72cceee90b1f8f8522867.tar.gz | |
MLECO-3252: Minor documentation additions
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>
Diffstat (limited to 'source/application')
| -rw-r--r-- | source/application/api/common/readme.md | 15 | ||||
| -rw-r--r-- | source/application/api/use_case/readme.md | 11 |
2 files changed, 26 insertions, 0 deletions
diff --git a/source/application/api/common/readme.md b/source/application/api/common/readme.md new file mode 100644 index 0000000..fbb1d76 --- /dev/null +++ b/source/application/api/common/readme.md @@ -0,0 +1,15 @@ +## API: Common + +This module contains utilities that can be re-used by all ML use case API. These include (but not limited to): + +* MFCC modules (used by most audio use cases) +* Image utilities +* Audio utilities (like sliding window API) +* Interface class for pre-processing and post-processing +* Model API that is extended by other use cases +* General TensorFlow Lite Micro helper functions + +## Useful links + +* [Repository Structure](../../../../docs/documentation.md#repository-structure) +* [Reusable Software](../../../../Readme.md#reusable-software). diff --git a/source/application/api/use_case/readme.md b/source/application/api/use_case/readme.md new file mode 100644 index 0000000..f7eb0d1 --- /dev/null +++ b/source/application/api/use_case/readme.md @@ -0,0 +1,11 @@ +## Use case APIs + +The directories in here are individual CMake projects to generate use case API static libraries. These libraries are +intended to be used by external projects that only want access to the ready-to-use ML use case pipelines implemented in this repository. +This can be as CMake projects, but also in the form of CMSIS-packs. These libraries do not depend on the HAL layer and +are platform-agnostic to allow for easy portability. + +## Useful links + +* [Repository Structure](../../../../docs/documentation.md#repository-structure) +* [Reusable Software](../../../../Readme.md#reusable-software). |