Skip to content

Commit e250838

Browse files
committed
doc: develop: manifests: external: add emlearn
Introduce documentation for using emlearn (TinyML library) as an external module in Zephyr. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
1 parent a123178 commit e250838

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
.. _external_module_emlearn:
2+
3+
emlearn
4+
#######
5+
6+
Introduction
7+
************
8+
9+
`emlearn`_ is an open source library for deploying machine learning models on micro-controllers
10+
and embedded systems. It provides portable C code generation from models trained with
11+
scikit-learn or Keras.
12+
13+
A Python library allows converting complex machine learning models to a minimal C code
14+
representation, which enables running ML inference on resource-constrained embedded devices.
15+
16+
emlearn is licensed under the MIT license.
17+
18+
Usage with Zephyr
19+
*****************
20+
21+
The emlearn repository is a Zephyr :ref:`module <modules>` which provides TinyML capabilities to
22+
Zephyr applications, allowing machine learning models to be run directly on Zephyr-powered devices.
23+
24+
To pull in emlearn as a Zephyr module, either add it as a West project in the ``west.yaml``
25+
file or pull it in by adding a submanifest (e.g. ``zephyr/submanifests/emlearn.yaml``) file
26+
with the following content and run ``west update``:
27+
28+
.. code-block:: yaml
29+
30+
manifest:
31+
projects:
32+
- name: emlearn
33+
url: https://github.com/emlearn/emlearn.git
34+
revision: master
35+
path: modules/lib/emlearn # adjust the path as needed
36+
37+
For more detailed instructions and API documentation, refer to the `emlearn documentation`_, and in
38+
particular the `Getting Started on Zephyr RTOS`_ section.
39+
40+
References
41+
**********
42+
43+
.. target-notes::
44+
45+
.. _emlearn:
46+
https://github.com/emlearn/emlearn
47+
48+
.. _emlearn documentation:
49+
https://emlearn.readthedocs.io/en/latest/
50+
51+
.. _Getting Started on Zephyr RTOS:
52+
https://emlearn.readthedocs.io/en/latest/getting_started_zephyr.html

0 commit comments

Comments
 (0)