mlonmcu 0.3.0.dev0__3-none-any.whl

mlonmcu-0.3.0.dev0.dist-info/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 TUM Department of Electrical and Computer Engineering - Chair of Electronic Design Automation
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

mlonmcu-0.3.0.dev0.dist-info/METADATA

@@ -0,0 +1,343 @@
+Metadata-Version: 2.1
+Name: mlonmcu
+Version: 0.3.0.dev0
+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
+Author-email: philipp.van-kempen@tum.de
+License: Apache License 2.0
+Keywords: mlonmcu
+Platform: UNKNOWN
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: GitPython
+Requires-Dist: Pillow
+Requires-Dist: filelock
+Requires-Dist: humanize
+Requires-Dist: jinja2 (<3.1)
+Requires-Dist: networkx
+Requires-Dist: numpy
+Requires-Dist: openpyxl
+Requires-Dist: pandas
+Requires-Dist: pyelftools
+Requires-Dist: pyyaml
+Requires-Dist: tqdm
+Requires-Dist: xdg
+Requires-Dist: xlsxwriter
+Requires-Dist: xlwt
+Provides-Extra: all-prod
+Requires-Dist: GitPython ; extra == 'all-prod'
+Requires-Dist: Pillow ; extra == 'all-prod'
+Requires-Dist: PrettyTable ; extra == 'all-prod'
+Requires-Dist: attrs ; extra == 'all-prod'
+Requires-Dist: bitstring (>=3.1.6) ; extra == 'all-prod'
+Requires-Dist: click (>=7.0) ; extra == 'all-prod'
+Requires-Dist: cloudpickle ; extra == 'all-prod'
+Requires-Dist: construct (==2.10.54) ; extra == 'all-prod'
+Requires-Dist: cryptography (>=2.1.4) ; extra == 'all-prod'
+Requires-Dist: decorator ; extra == 'all-prod'
+Requires-Dist: ecdsa (>=0.16.0) ; extra == 'all-prod'
+Requires-Dist: filelock ; extra == 'all-prod'
+Requires-Dist: future (>=0.15.2) ; extra == 'all-prod'
+Requires-Dist: gdbgui (==0.13.2.0) ; extra == 'all-prod'
+Requires-Dist: graphviz ; extra == 'all-prod'
+Requires-Dist: humanize ; extra == 'all-prod'
+Requires-Dist: idf-component-manager (~=1.0) ; extra == 'all-prod'
+Requires-Dist: itsdangerous (<2.1) ; extra == 'all-prod'
+Requires-Dist: jinja2 (<3.1) ; extra == 'all-prod'
+Requires-Dist: kconfiglib (==13.7.1) ; extra == 'all-prod'
+Requires-Dist: matplotlib ; extra == 'all-prod'
+Requires-Dist: networkx ; extra == 'all-prod'
+Requires-Dist: numpy ; extra == 'all-prod'
+Requires-Dist: onnx ; extra == 'all-prod'
+Requires-Dist: openpyxl ; extra == 'all-prod'
+Requires-Dist: ortools ; extra == 'all-prod'
+Requires-Dist: pandas ; extra == 'all-prod'
+Requires-Dist: psutil ; extra == 'all-prod'
+Requires-Dist: pyelftools ; extra == 'all-prod'
+Requires-Dist: pygdbmi (<=0.9.0.2) ; extra == 'all-prod'
+Requires-Dist: pyparsing (<2.4.0,>=2.0.3) ; extra == 'all-prod'
+Requires-Dist: pyserial ; extra == 'all-prod'
+Requires-Dist: python-socketio (<5) ; extra == 'all-prod'
+Requires-Dist: pyusb ; extra == 'all-prod'
+Requires-Dist: pyyaml ; extra == 'all-prod'
+Requires-Dist: reedsolo (<=1.5.4,>=1.5.3) ; extra == 'all-prod'
+Requires-Dist: relayviz ; extra == 'all-prod'
+Requires-Dist: scipy ; extra == 'all-prod'
+Requires-Dist: synr ; extra == 'all-prod'
+Requires-Dist: tensorflow (~=2.8.0) ; extra == 'all-prod'
+Requires-Dist: tflite (>=2.4.0) ; extra == 'all-prod'
+Requires-Dist: tornado ; extra == 'all-prod'
+Requires-Dist: tqdm ; extra == 'all-prod'
+Requires-Dist: typing-extensions ; extra == 'all-prod'
+Requires-Dist: xdg ; extra == 'all-prod'
+Requires-Dist: xgboost (~=1.5.2) ; extra == 'all-prod'
+Requires-Dist: xlsxwriter ; extra == 'all-prod'
+Requires-Dist: xlwt ; extra == 'all-prod'
+Provides-Extra: espidf
+Requires-Dist: bitstring (>=3.1.6) ; extra == 'espidf'
+Requires-Dist: click (>=7.0) ; extra == 'espidf'
+Requires-Dist: construct (==2.10.54) ; extra == 'espidf'
+Requires-Dist: cryptography (>=2.1.4) ; extra == 'espidf'
+Requires-Dist: ecdsa (>=0.16.0) ; extra == 'espidf'
+Requires-Dist: future (>=0.15.2) ; extra == 'espidf'
+Requires-Dist: gdbgui (==0.13.2.0) ; extra == 'espidf'
+Requires-Dist: idf-component-manager (~=1.0) ; extra == 'espidf'
+Requires-Dist: itsdangerous (<2.1) ; extra == 'espidf'
+Requires-Dist: jinja2 (<3.1) ; extra == 'espidf'
+Requires-Dist: kconfiglib (==13.7.1) ; extra == 'espidf'
+Requires-Dist: psutil ; extra == 'espidf'
+Requires-Dist: pygdbmi (<=0.9.0.2) ; extra == 'espidf'
+Requires-Dist: pyparsing (<2.4.0,>=2.0.3) ; extra == 'espidf'
+Requires-Dist: pyserial ; extra == 'espidf'
+Requires-Dist: python-socketio (<5) ; extra == 'espidf'
+Requires-Dist: reedsolo (<=1.5.4,>=1.5.3) ; extra == 'espidf'
+Provides-Extra: etiss
+Requires-Dist: humanize ; extra == 'etiss'
+Requires-Dist: pyelftools ; extra == 'etiss'
+Provides-Extra: gvsoc_pulp
+Requires-Dist: PrettyTable ; extra == 'gvsoc_pulp'
+Provides-Extra: microtvm
+Requires-Dist: pyserial ; extra == 'microtvm'
+Requires-Dist: pyusb ; extra == 'microtvm'
+Provides-Extra: moiopt
+Requires-Dist: ortools ; extra == 'moiopt'
+Provides-Extra: onnx
+Requires-Dist: onnx ; extra == 'onnx'
+Provides-Extra: relay-visualization
+Requires-Dist: relayviz ; extra == 'relay-visualization'
+Provides-Extra: tflite
+Requires-Dist: tflite (>=2.4.0) ; extra == 'tflite'
+Provides-Extra: tflm
+Requires-Dist: Pillow ; extra == 'tflm'
+Provides-Extra: tvm
+Requires-Dist: attrs ; extra == 'tvm'
+Requires-Dist: cloudpickle ; extra == 'tvm'
+Requires-Dist: decorator ; extra == 'tvm'
+Requires-Dist: graphviz ; extra == 'tvm'
+Requires-Dist: numpy ; extra == 'tvm'
+Requires-Dist: psutil ; extra == 'tvm'
+Requires-Dist: scipy ; extra == 'tvm'
+Requires-Dist: synr ; extra == 'tvm'
+Requires-Dist: tornado ; extra == 'tvm'
+Requires-Dist: typing-extensions ; extra == 'tvm'
+Provides-Extra: tvm-autotuning
+Requires-Dist: xgboost (~=1.5.2) ; extra == 'tvm-autotuning'
+Provides-Extra: visualize
+Requires-Dist: matplotlib ; extra == 'visualize'
+Provides-Extra: visualize_tflite
+Requires-Dist: tensorflow (~=2.8.0) ; extra == 'visualize_tflite'
+Provides-Extra: zephyr
+Requires-Dist: pyserial ; extra == 'zephyr'
+
+# ML on MCU
+
+[![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)
+[![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)
+[![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.
+
+
+* Free software: Apache License, Version 2.0
+* Python Package: [https://pypi.org/project/mlonmcu/](https://pypi.org/project/mlonmcu/)
+* Documentation: [https://mlonmcu.readthedocs.io](https://mlonmcu.readthedocs.io) or [https://tum-ei-eda.github.io/mlonmcu/](https://tum-ei-eda.github.io/mlonmcu/)
+
+
+## Features
+
+- Highly configurable python package
+- Automatic resolution and installation of dependencies
+- Supporting a large combination of frameworks/backends/targets/features:
+  - Frameworks (Backends): TFLite Micro, MircoTVM
+  - Targets: Host (x86), ETISS (Pulpino), Corstone300 (ARM Cortex-M), QEMU (RISC-V), Spike (`riscv-isa-sim`),...
+  - Platforms: Zephyr, ESP-IDF,...
+  - Features: Autotuning, Debugging, RPC,...
+- Build-in parallel processing of large number of benchmarks
+- Isolated enironments (not interfering with other installations)
+- Command Line and Python Development Interfaces
+- Docker images to get started quickly
+- Extensive documentation on usage and code details
+- CI/CD integration and high PyTest coverage
+
+## Getting started
+
+### Prerequisites
+
+#### Ubuntu/Debian
+
+First, a set of APT packages needs to be installed:
+
+```
+# Python related
+sudo apt install python3-pip python3-venv
+
+# MLonMCU related
+sudo apt install libboost-system-dev libboost-filesystem-dev libboost-program-options-dev graphviz doxygen libtinfo-dev zlib1g-dev texinfo unzip device-tree-compiler tree g++
+
+# Optional (depending on configuration)
+sudo apt install ninja-build
+```
+
+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`.
+
+**Warning:** It seems like the ETISS tool fails to compile if if find a version of LLVM 11 on your system which does not include Clang 11. The best workaround for now is to (if possible) remove those tools from your system: `sudo apt remove llvm-11* clang-11*` (See issue #1)
+
+Make sure to use a fresh virtual Python environment in the following steps.
+
+##### Install Release from PyPI
+
+**Warning:** As the PyPI package is not always up to date, it is currently recommented to use a self-build version of the package (as explained in the next section)
+
+To use the PIP package, run the following: `pip install mlonmcu` (Add `--user` if you are not using a virtual environment)
+
+
+#### Build Package manually
+
+First, install all relevant dependencies:
+
+```
+python -m venv .venv  # Feel free to choose a different directory or use a conda environment
+
+# Run this whenever your have updated the repository
+source .venv/bin/activate
+
+# Environment-specific dependencies are installed later
+
+**Warning:** It is recommended to have at least version 3.20 of CMake installed for full compatibility!
+
+# Install minimal dependencies
+pip install -r requirements_dev.txt
+
+# Optional (only for development)
+pip install -r requirements_dev.txt
+pip install -r docs/requirements.txt
+
+# Only if you want to use the provided python notebooks, as explained in  ./ipynb/README.md
+pip install -r ipynb/requirements.txt
+```
+
+Then you should be able to install the `mlonmcu` python package like this
+
+```
+# Optionally remove an older version first: pip uninstall mlonmcu
+
+make install  # Alternative: python setup.py install
+```
+
+#### Docker (Any other OS)
+
+See [`./docker/README.md`](https://github.com/tum-ei-eda/mlonmcu/blob/main/docker/README.md) for more details.
+
+This repository ships three different types of docker images based on Debian:
+
+- A minimal one with preinstalled software dependencies and python packages
+
+  Feel free to use this one if you do not want to install anything (except Docker) on your main sytem to work with mlonmcu
+- A medium one which already has the `mlonmcu` python package installed
+
+  Recommended and the easiest to use. (Especially when using `docker-compose` to mount shared directories etc.)
+
+- A very large one with an already initialized and installed
+
+  Mainly used for triggering automated benchmarks without spending too much time on downloading/compiling heavy dependencies over and over again.
+
+### Usage
+
+Is is recommended to checkout the provided [Demo Jupyter Notebook](https://github.com/tum-ei-eda/mlonmcu/blob/main/ipynb/Demo.ipynb) as it contains a end-to-end example which should help to understand the main concepts and methodology of the tool. The following paragraphs can be seen as a TL;DL version of the information in that Demo notebook.
+
+While some tools and features of this project work out of the box, some of them require setting up an environment where additional dependencies are installed. This can be achived by creating a MLonMCU environment as follows:
+
+```bash
+mlonmcu init
+```
+
+Make sure to point the `MLONMCU_HOME` environment variable to the location of the previously initialied environment. (Alternative: use the `default` environment or `--home` argument on the command line)
+
+Next, generate a `requirements.txt` file inside the environment directory using `mlonmcu setup -g` which now be installed by running `pip install -r $MLONMCU_HOME/requirements.txt` inside the virtual Python environment.
+
+
+To use the created environment in a python program, a `MlonMcuContext` needs to be created as follows:
+
+```
+import mlonmcu.context
+
+with mlonmcu.context.MlonMcuContext() as context:
+    pass
+```
+
+
+## Development
+
+Make sure to first install the additonal set of development Python packages into your virtual environment:
+
+```
+pip install -r requirements_all.txt  # Install packages for every component (instead of using mlonmcu setup -g)
+pip install -r requirements_dev.txt  # Building distributions and running tests
+pip install -r docs/requirements.txt  # For working with the documentation
+```
+
+Unit test and integration test are defined in the `tests/` directory and can be triggered using `make test` or `pytest tests/`
+
+Coverage can be determined by running `make coverage`. The latest coverage report (HTML) for the default branch can also be found as an artifact of the CI/CD workflow.
+
+Documentation is mainly generated automatically from doctrings (triggered via `make html`). It is also possible to include markdown files from the repo into the `.rst` files found in the [`docs/`](./docs/) directory. There is a GitHub workflow which publishes the documentation for the default branch to our [GitHub Pages](https://tum-ei-eda.github.io/mlonmcu).
+
+Regarding coding style, it is recommended to run `black` before every commit. The default line length should be given in the `setup.cfg` file.
+
+### Future Work
+
+- [ ] Finish beta version `v0.1.0`
+- [ ] Open Source Release
+  - [ ] Make repository public
+  - [ ] Release python package
+  - [ ] Publish docs automatically to https://readthedocs.org
+
+## Credits
+
+This is a research project proposed by the Chair of Design Automation of the Technical University of Munich.
+
+### Developers
+
+- Rafael Stahl (TUM) [@rafzi]
+
+  - Wrote initial version of the MLonMCU project
+
+- Philipp van Kempen (TUM) [@PhilippvK]
+
+  - Came up with MLonMCU Python package
+
+
+### 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
+
+
+# History
+
+## 0.1.0 (2021-11-12)
+
+* First closed-source release.
+
+

mlonmcu-0.3.0.dev0.dist-info/NOTICE

@@ -0,0 +1,8 @@
+the file gen_requirements.py come with the following notice:
+
+Apache TVM
+Copyright 2019-2022 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+