summaryrefslogtreecommitdiff
path: root/source/application/api/common/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'source/application/api/common/readme.md')
-rw-r--r--source/application/api/common/readme.md15
1 files changed, 15 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).