From 8ce2be8de498f328678eeed998dbe6994734c15e Mon Sep 17 00:00:00 2001 From: Isabella Gottardi Date: Mon, 20 Mar 2023 15:35:42 +0000 Subject: MLECO-3802: [Maintenance] Remove Pillow warning - Image.Resampling.BILINEAR replace deprecated Image.BILINEAR - Trivial documentation fixes Change-Id: Ia75af2d2bf171085d4a0a2c472f0e3f94dbdc5b9 Signed-off-by: Isabella Gottardi --- source/application/api/common/readme.md | 2 +- source/application/api/use_case/readme.md | 11 ++++------- source/hal/readme.md | 2 +- source/log/readme.md | 2 +- source/math/readme.md | 2 +- source/profiler/readme.md | 2 +- source/use_case/readme.md | 2 +- 7 files changed, 10 insertions(+), 13 deletions(-) (limited to 'source') diff --git a/source/application/api/common/readme.md b/source/application/api/common/readme.md index fbb1d76..6ae8780 100644 --- a/source/application/api/common/readme.md +++ b/source/application/api/common/readme.md @@ -1,4 +1,4 @@ -## API: Common +# API: Common This module contains utilities that can be re-used by all ML use case API. These include (but not limited to): diff --git a/source/application/api/use_case/readme.md b/source/application/api/use_case/readme.md index 419dee0..b8fdfc7 100644 --- a/source/application/api/use_case/readme.md +++ b/source/application/api/use_case/readme.md @@ -1,3 +1,5 @@ +# Use case APIs + - [Use case APIs](#use-case-apis) - [Anomaly detection](#anomaly-detection) - [Automatic speech recognition](#automatic-speech-recognition) @@ -9,8 +11,6 @@ - [Visual wake word](#visual-wake-word) - [Useful links](#useful-links) -# 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, @@ -61,10 +61,7 @@ bounding boxes that encapsulate the faces. This use case takes images as input and determines, with a certain probability, whether the image contains a person. - ## Useful links -* [Project ReadMe](../../../../Readme.md) -* [Reusable Software](../../../../Readme.md#reusable-software) - - +- [Project ReadMe](../../../../Readme.md) +- [Reusable Software](../../../../Readme.md#reusable-software) diff --git a/source/hal/readme.md b/source/hal/readme.md index 1757d5b..d0562e1 100644 --- a/source/hal/readme.md +++ b/source/hal/readme.md @@ -1,4 +1,4 @@ -## HAL project +# HAL project This directory is the root of `Hardware Abstraction Layer` (HAL) library for this repo. The intention is for this layer to service higher layers to seamlessly use platform specific functionality via a single abstraction layer. HAL provides diff --git a/source/log/readme.md b/source/log/readme.md index 9b2c137..29cb467 100644 --- a/source/log/readme.md +++ b/source/log/readme.md @@ -1,4 +1,4 @@ -## Log +# Log This is a CMake interface library that exposes helper macros related to logging. This component is used by almost all the others in this repository directly or transitively. diff --git a/source/math/readme.md b/source/math/readme.md index bee889d..3c77cbb 100644 --- a/source/math/readme.md +++ b/source/math/readme.md @@ -1,4 +1,4 @@ -## Math +# Math This is a CMake static library that allows application level code and ML use case APIs to use basic mathematical functions on scalars and vectors. This library calls the standard C/C++ math functions when being compiled for diff --git a/source/profiler/readme.md b/source/profiler/readme.md index 92b7c2f..48bb35b 100644 --- a/source/profiler/readme.md +++ b/source/profiler/readme.md @@ -1,4 +1,4 @@ -## Profiler +# Profiler This is a CMake static library that exposes a C++ API for a very simple logging based profiler implementation. It depends on the hardware abstraction layer's platform drivers to get performance measurement counters (PMU) from the diff --git a/source/use_case/readme.md b/source/use_case/readme.md index 24b0c4e..9e32dfb 100644 --- a/source/use_case/readme.md +++ b/source/use_case/readme.md @@ -1,4 +1,4 @@ -## ML Use case examples +# ML Use case examples This directory contains several ML example use case implementations. Sources here sit at the highest level in the hierarchy. See [Building](../../docs/documentation.md#building) and -- cgit v1.2.1