diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..303f2a3 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt diff --git a/README.md b/README.md index fd39001..091316e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -[![Python version: 3.8 | 3.9 | 3.10](https://img.shields.io/badge/python-3.9%20|%203.10-blue)](https://www.python.org/downloads/) +[![Python version: 3.8 | 3.9 | 3.10](https://img.shields.io/badge/python-3.8%20|3.9%20|%203.10-blue)](https://www.python.org/downloads/) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/fpaissan/micromind/blob/main/LICENSE) -![PyPI version](https://img.shields.io/pypi/v/micromind) +[![PyPI version](https://img.shields.io/pypi/v/micromind)](https://pypi.org/project/micromind/) This is the official repo of `micromind`, a toolkit that aims at bridging two communities: artificial intelligence and embedded systems. `micromind` is based on [PyTorch](https://pytorch.org) and provides exportability for the supported models in ONNX, Intel OpenVINO, and TFLite. diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..8213302 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx +sphinx_rtd_theme diff --git a/docs/source/index.rst b/docs/source/index.rst index 742fcc8..22c506a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,13 +6,14 @@ Welcome to micromind's documentation! ===================================== -.. image:: https://img.shields.io/badge/python-3.9%20|%203.10-blue +.. image:: https://img.shields.io/badge/python-3.8%20|3.9%20|%203.10-blue :target: https://www.python.org/downloads/ .. image:: https://img.shields.io/badge/License-Apache_2.0-blue.svg :target: https://github.com/fpaissan/micromind/blob/main/LICENSE .. image:: https://img.shields.io/pypi/v/micromind + :target: https://pypi.org/project/micromind/ This is the official repository of `micromind`, a toolkit that aims to bridge two communities: artificial intelligence and embedded systems. `micromind` is based on `PyTorch `_ and provides exportability for the supported models in ONNX, Intel OpenVINO, and TFLite. diff --git a/micromind/__init__.py b/micromind/__init__.py index 7ec91f3..efdf2a8 100644 --- a/micromind/__init__.py +++ b/micromind/__init__.py @@ -1,7 +1,8 @@ from .core import MicroMind, Metric, Stage # Package version -__version__ = "0.1.0" +__version__ = "0.1.1" + """datasets_info is a dictionary that contains information about the attributes of the datasets. diff --git a/pyproject.toml b/pyproject.toml index b72ae4c..10b2b50 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -56,7 +56,8 @@ profile = "black" py-modules = [] [tool.bumpver] -current_version = "0.1.0" +current_version = "0.1.1" + version_pattern = "MAJOR.MINOR.PATCH" commit_message = "bump version {old_version} -> {new_version}" commit = true