MiroAI's most commonly used computer-vision related python functions now at your fingertips!
To install and test the miro-vision-toolbox locally:
git clone --shallow https://github.com/miroai/miro-vision-toolbox.git
cd miro-vision-toolbox
pip install -e .
Before pushing your commits, please make sure tests are ran! Tests are included in each function's docstring and can be ran using Python's doctest. To run tests on toolbox.img_utils:
python -m doctest -v toolbox/img_utils.py
To learn more about doctest see here
This package's documentation is located here (github page).
Thea Docs are automagically generated using mkdocs (see RealPython's excellent tutorial here). Additionally examples are generated using Jupyter notebook and converted into documentation thanks to mkdocs-jupyter.
Running mkdocs gh-deploy will update the live site (to be ran only after testing). To see the documentation page locally before pushing, run mkdocs serve then go to http://localhost:800