mlonmcu 0.4.dev0__tar.gz → 0.5.0__tar.gz

{mlonmcu-0.4.dev0 → mlonmcu-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mlonmcu
-Version: 0.4.dev0
+Version: 0.5.0
 Summary: This project contains research code related to the deployment of inferenceor learning applications on tiny micro-controllers.
 Home-page: https://github.com/tum-ei-eda/mlonmcu
 Author: TUM Department of Electrical and Computer Engineering - Chair of Electronic Design Automation
@@ -21,6 +21,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
+Provides-Extra: all-prod
 Provides-Extra: espidf
 Provides-Extra: etiss
 Provides-Extra: gvsoc_pulp
@@ -35,7 +36,6 @@ Provides-Extra: tvm-autotuning
 Provides-Extra: visualize
 Provides-Extra: visualize_tflite
 Provides-Extra: zephyr
-Provides-Extra: all-prod
 License-File: LICENSE
 License-File: NOTICE
 
@@ -43,14 +43,15 @@ License-File: NOTICE
 
 [![pypi package](https://badge.fury.io/py/mlonmcu.svg)](https://pypi.org/project/mlonmcu)
 [![readthedocs](https://readthedocs.org/projects/mlonmcu/badge/?version=latest)](https://mlonmcu.readthedocs.io/en/latest/?version=latest)
-![covergae](https://byob.yarr.is/tum-ei-eda/mlonmcu/coverage)
+![coverage](https://byob.yarr.is/tum-ei-eda/mlonmcu/coverage)
 [![GitHub license](https://img.shields.io/github/license/tum-ei-eda/mlonmcu.svg)](https://github.com/tum-ei-eda/mlonmcu/blob/main/LICENSE)
 
 [![cicd workflow](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/cicd.yml/badge.svg)](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/cicd.yml)
+[![lint workflow](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/style.yml/badge.svg)](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/style.yml)
 [![demo workflow](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/demo.yml/badge.svg)](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/demo.yml)
-[![container workflow](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/container.yml/badge.svg)](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/container.yml)
 [![bench workflow](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/bench.yml/badge.svg)](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/bench.yml)
 
+
 This project contains research code related to the deployment of inference or learning applications on tiny micro-controllers.
 
 
@@ -87,7 +88,7 @@ sudo apt install python3-pip python3-venv
 sudo apt install libboost-all-dev graphviz doxygen libtinfo-dev zlib1g-dev texinfo unzip device-tree-compiler tree g++
 
 # Optional (depending on configuration)
-sudo apt install ninja-build flex
+sudo apt install ninja-build flex lsb-release libelf-dev
 ```
 
 Also make sure that your default Python is at least v3.7. If the `python` command is not available in your shell or points Python v2.7 check out `python-is-python3`.
@@ -174,6 +175,14 @@ with mlonmcu.context.MlonMcuContext() as context:
     pass
 ```
 
+## List of interesting MLonMCU forks
+
+- MINRES TGC support: https://github.com/Minres/mlonmcu/tree/develop
+
+## List of existing MLonMCU extensions/plugins
+
+- ABC Example Plugin: coming soon!
+- MINRES TGC Support: coming soon!
 
 ## Development
 
@@ -193,10 +202,6 @@ Documentation is mainly generated automatically from doctrings (triggered via `m
 
 Regarding coding style, it is recommended to run `black` before every commit. The default line length should be given in the `setup.cfg` file.
 
-## Credits
-
-This is a research project proposed by the Chair of Design Automation of the Technical University of Munich.
-
 ### Developers
 
 - Rafael Stahl (TUM) [@rafzi]
@@ -207,6 +212,33 @@ This is a research project proposed by the Chair of Design Automation of the Tec
 
   - Came up with MLonMCU Python package
 
+## Publications
+
+- **MLonMCU: TinyML Benchmarking with Fast Retargeting** ([https://dl.acm.org/doi/10.1145/3637543.3652878](https://dl.acm.org/doi/abs/10.1145/3615338.3618128))
+
+  *CODAI '23: Proceedings of the 2023 Workshop on Compilers, Deployment, and Tooling for Edge AI*
+
+  BibTeX
+
+  ```bibtex
+  @inproceedings{10.1145/3615338.3618128,
+    author = {van Kempen, Philipp and Stahl, Rafael and Mueller-Gritschneder, Daniel and Schlichtmann, Ulf},
+    title = {MLonMCU: TinyML Benchmarking with Fast Retargeting},
+    year = {2024},
+    isbn = {9798400703379},
+    publisher = {Association for Computing Machinery},
+    address = {New York, NY, USA},
+    url = {https://doi.org/10.1145/3615338.3618128},
+    doi = {10.1145/3615338.3618128},
+    abstract = {While there exist many ways to deploy machine learning models on microcontrollers, it is non-trivial to choose the optimal combination of frameworks and targets for a given application. Thus, automating the end-to-end benchmarking flow is of high relevance nowadays. A tool called MLonMCU is proposed in this paper and demonstrated by benchmarking the state-of-the-art TinyML frameworks TFLite for Microcontrollers and TVM effortlessly with a large number of configurations in a low amount of time.},
+    booktitle = {Proceedings of the 2023 Workshop on Compilers, Deployment, and Tooling for Edge AI},
+    pages = {32–36},
+    numpages = {5},
+    keywords = {TinyML, neural networks, microcontrollers},
+    location = {Hamburg, Germany},
+    series = {CODAI '23}
+  }
+  ```
 
 ### Other
 This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. However most of the templates was manually changed to be in Markdown instead of reStructuredText.
@@ -215,6 +247,14 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack
 - **`audreyr/cookiecutter-pypackage`:** https://github.com/audreyr/cookiecutter-pypackage
 
 
+## Acknowledgment
+
+<img src="./BMBF_gefoerdert_2017_en.jpg" alt="drawing" height="75" align="left" >
+
+This research is partially funded by the German Federal Ministry of Education and Research (BMBF) within
+the projects [Scale4Edge](https://www.edacentrum.de/scale4edge/) (grant number 16ME0127) and [MANNHEIM-FlexKI](https://www.edacentrum.de/projekte/MANNHEIM-FlexKI) (grant number 01IS22086L).
+
+
 # History
 
 ## 0.1.0 (2021-11-12)

{mlonmcu-0.4.dev0 → mlonmcu-0.5.0}/README.md

@@ -2,14 +2,15 @@
 
 [![pypi package](https://badge.fury.io/py/mlonmcu.svg)](https://pypi.org/project/mlonmcu)
 [![readthedocs](https://readthedocs.org/projects/mlonmcu/badge/?version=latest)](https://mlonmcu.readthedocs.io/en/latest/?version=latest)
-![covergae](https://byob.yarr.is/tum-ei-eda/mlonmcu/coverage)
+![coverage](https://byob.yarr.is/tum-ei-eda/mlonmcu/coverage)
 [![GitHub license](https://img.shields.io/github/license/tum-ei-eda/mlonmcu.svg)](https://github.com/tum-ei-eda/mlonmcu/blob/main/LICENSE)
 
 [![cicd workflow](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/cicd.yml/badge.svg)](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/cicd.yml)
+[![lint workflow](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/style.yml/badge.svg)](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/style.yml)
 [![demo workflow](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/demo.yml/badge.svg)](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/demo.yml)
-[![container workflow](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/container.yml/badge.svg)](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/container.yml)
 [![bench workflow](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/bench.yml/badge.svg)](https://github.com/tum-ei-eda/mlonmcu/actions/workflows/bench.yml)
 
+
 This project contains research code related to the deployment of inference or learning applications on tiny micro-controllers.
 
 
@@ -46,7 +47,7 @@ sudo apt install python3-pip python3-venv
 sudo apt install libboost-all-dev graphviz doxygen libtinfo-dev zlib1g-dev texinfo unzip device-tree-compiler tree g++
 
 # Optional (depending on configuration)
-sudo apt install ninja-build flex
+sudo apt install ninja-build flex lsb-release libelf-dev
 ```
 
 Also make sure that your default Python is at least v3.7. If the `python` command is not available in your shell or points Python v2.7 check out `python-is-python3`.
@@ -133,6 +134,14 @@ with mlonmcu.context.MlonMcuContext() as context:
     pass
 ```
 
+## List of interesting MLonMCU forks
+
+- MINRES TGC support: https://github.com/Minres/mlonmcu/tree/develop
+
+## List of existing MLonMCU extensions/plugins
+
+- ABC Example Plugin: coming soon!
+- MINRES TGC Support: coming soon!
 
 ## Development
 
@@ -152,10 +161,6 @@ Documentation is mainly generated automatically from doctrings (triggered via `m
 
 Regarding coding style, it is recommended to run `black` before every commit. The default line length should be given in the `setup.cfg` file.
 
-## Credits
-
-This is a research project proposed by the Chair of Design Automation of the Technical University of Munich.
-
 ### Developers
 
 - Rafael Stahl (TUM) [@rafzi]
@@ -166,9 +171,44 @@ This is a research project proposed by the Chair of Design Automation of the Tec
 
   - Came up with MLonMCU Python package
 
+## Publications
+
+- **MLonMCU: TinyML Benchmarking with Fast Retargeting** ([https://dl.acm.org/doi/10.1145/3637543.3652878](https://dl.acm.org/doi/abs/10.1145/3615338.3618128))
+
+  *CODAI '23: Proceedings of the 2023 Workshop on Compilers, Deployment, and Tooling for Edge AI*
+
+  BibTeX
+
+  ```bibtex
+  @inproceedings{10.1145/3615338.3618128,
+    author = {van Kempen, Philipp and Stahl, Rafael and Mueller-Gritschneder, Daniel and Schlichtmann, Ulf},
+    title = {MLonMCU: TinyML Benchmarking with Fast Retargeting},
+    year = {2024},
+    isbn = {9798400703379},
+    publisher = {Association for Computing Machinery},
+    address = {New York, NY, USA},
+    url = {https://doi.org/10.1145/3615338.3618128},
+    doi = {10.1145/3615338.3618128},
+    abstract = {While there exist many ways to deploy machine learning models on microcontrollers, it is non-trivial to choose the optimal combination of frameworks and targets for a given application. Thus, automating the end-to-end benchmarking flow is of high relevance nowadays. A tool called MLonMCU is proposed in this paper and demonstrated by benchmarking the state-of-the-art TinyML frameworks TFLite for Microcontrollers and TVM effortlessly with a large number of configurations in a low amount of time.},
+    booktitle = {Proceedings of the 2023 Workshop on Compilers, Deployment, and Tooling for Edge AI},
+    pages = {32–36},
+    numpages = {5},
+    keywords = {TinyML, neural networks, microcontrollers},
+    location = {Hamburg, Germany},
+    series = {CODAI '23}
+  }
+  ```
 
 ### Other
 This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. However most of the templates was manually changed to be in Markdown instead of reStructuredText.
 
 - **Cookiecutter:** https://github.com/audreyr/cookiecutter
 - **`audreyr/cookiecutter-pypackage`:** https://github.com/audreyr/cookiecutter-pypackage
+
+
+## Acknowledgment
+
+<img src="./BMBF_gefoerdert_2017_en.jpg" alt="drawing" height="75" align="left" >
+
+This research is partially funded by the German Federal Ministry of Education and Research (BMBF) within
+the projects [Scale4Edge](https://www.edacentrum.de/scale4edge/) (grant number 16ME0127) and [MANNHEIM-FlexKI](https://www.edacentrum.de/projekte/MANNHEIM-FlexKI) (grant number 01IS22086L).

{mlonmcu-0.4.dev0 → mlonmcu-0.5.0}/mlonmcu/artifact.py

@@ -40,7 +40,7 @@ class ArtifactFormat(Enum):  # TODO: ArtifactType, ArtifactKind?
     DATA = 6
     NUMPY = 7
     PARAMS = 8
-    JSON = 9  # ?
+    JSON = 9  # TODO: how about YAML or more general: DICT?
     PATH = 10  # NOT A DIRECTORY?
     RAW = 11
     BIN = 11
@@ -50,6 +50,8 @@ class ArtifactFormat(Enum):  # TODO: ArtifactType, ArtifactKind?
 
 def lookup_artifacts(artifacts, name=None, fmt=None, flags=None, first_only=False):
     """Utility to get a matching artifact for a given set of properties."""
+    if isinstance(name, Path):
+        name = str(name)
     matches = []
     # Warning: if neither name, fmt nor flags is provided, the first artifact (first_only=True)
     # or all (first_only=False) are returned

{mlonmcu-0.4.dev0 → mlonmcu-0.5.0}/mlonmcu/cli/common.py

@@ -119,9 +119,11 @@ def add_flow_options(parser):
                 metavar="FEATURES",
                 nargs="+",
                 action="append",
-                help=f"Generator statement for features. (Also available: --feature-gen2 ... --feature-gen{number})"
-                if i == 0
-                else argparse.SUPPRESS,
+                help=(
+                    f"Generator statement for features. (Also available: --feature-gen2 ... --feature-gen{number})"
+                    if i == 0
+                    else argparse.SUPPRESS
+                ),
             )
             flow_parser.add_argument(
                 "--config-gen" + suffix,
@@ -129,9 +131,11 @@ def add_flow_options(parser):
                 metavar="KEY=VALUE",
                 nargs="+",
                 action="append",
-                help=f"Generator statement for configs. (Also available: --config-gen2 ... --config-gen{number})"
-                if i == 0
-                else argparse.SUPPRESS,
+                help=(
+                    f"Generator statement for configs. (Also available: --config-gen2 ... --config-gen{number})"
+                    if i == 0
+                    else argparse.SUPPRESS
+                ),
             )
 
     add_gen_args(flow_parser, NUM_GEN_ARGS)

{mlonmcu-0.4.dev0 → mlonmcu-0.5.0}/mlonmcu/cli/main.py

@@ -81,6 +81,7 @@ def handle_docker(args):
 # def main(args):
 def main(args=None):
     """Console script for mlonmcu."""
+
     parser = argparse.ArgumentParser(
         description="ML on MCU Flow",
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,

{mlonmcu-0.4.dev0 → mlonmcu-0.5.0}/mlonmcu/context/context.py

@@ -226,7 +226,8 @@ def resolve_environment_file(name: str = None, path: str = None) -> Path:
         env_file = lookup_environment()
         if not env_file:
             raise RuntimeError("Lookup for mlonmcu environment was not successful.")
-    return env_file
+    assert env_file is not None, "Environment not found!"
+    return Path(env_file)
 
 
 def setup_logging(environment):
@@ -273,6 +274,14 @@ class MlonMcuContext:
         env_file = resolve_environment_file(name=name, path=path)
         assert env_file is not None, "Unable to find a MLonMCU environment"
         self.environment = UserEnvironment.from_file(env_file)  # TODO: move to __enter__
+        actual_home = env_file.parent.resolve()
+        specified_home = Path(self.environment.home).resolve()
+        if specified_home != actual_home:
+            logger.warning(
+                "The HOME directory %s specified in environment.yml does not match workspace directory %s!",
+                specified_home,
+                actual_home,
+            )
         setup_logging(self.environment)
         assert deps_lock in ["read", "write"]
         if deps_lock == "read":

{mlonmcu-0.4.dev0 → mlonmcu-0.5.0}/mlonmcu/environment/init.py

@@ -17,7 +17,6 @@
 # limitations under the License.
 #
 import sys
-import git
 from pathlib import Path
 import venv
 import os
@@ -32,6 +31,7 @@ from .config import (
 )
 from .templates import write_environment_yaml_from_template
 from mlonmcu.utils import in_virtualenv, ask_user
+from mlonmcu.setup import utils
 from mlonmcu.logging import get_logger
 
 logger = get_logger()
@@ -46,10 +46,10 @@ def create_environment_directories(path, directories):
         (path / directory).mkdir(parents=True, exist_ok=True)
 
 
-def clone_models_repo(
-    dest, url="https://github.com/tum-ei-eda/mlonmcu-models.git"
-):  # TODO: how to get submodule url/ref
-    git.Repo.clone_from(url, dest)
+def clone_models_repo(dest, url=None, ref=None, refresh=False, recursive=False):
+    if url is None:
+        url = "https://github.com/tum-ei-eda/mlonmcu-models.git"
+    utils.clone(url, dest, ref, refresh=refresh, recursive=False)
 
 
 def create_venv_directory(base, hidden=True):
@@ -157,7 +157,11 @@ def initialize_environment(
                 interactive=interactive,
             )
         ):
-            clone_models_repo(models_subdir)
+            custom_url = None
+            custom_ref = None
+            custom_url = config.get("models.clone_url", None)
+            custom_ref = config.get("models.clone_ref", None)
+            clone_models_repo(models_subdir, url=custom_url, ref=custom_ref)
         else:
             subdirs.append("models")