Refactor documentation for Supervision |
||
|---|---|---|
| .github | ||
| docs | ||
| supervision | ||
| test | ||
| .gitignore | ||
| LICENSE.md | ||
| Makefile | ||
| README.md | ||
| mkdocs.yml | ||
| requirements.txt | ||
| setup.py | ||
README.md
👋 hello
A set of easy-to-use utils that will come in handy in any Computer Vision project. Supervision is still in pre-release stage. 🚧 Keep your eyes open for potential bugs and be aware that at this stage our API is still fluid and may change.
💻 install
Pip install the supervision package in a 3.10>=Python>=3.7 environment.
pip install supervision
Install from source
# clone repository and navigate to root directory
git clone https://github.com/roboflow/supervision.git
cd supervision
# setup python environment and activate it
python3 -m venv venv
source venv/bin/activate
# install
pip install -e ".[dev]"
📖 documentation
Curious how Supervision can help you solve problems on your project? Visit our documentation page!
🎬 videos
Learn how to use YOLOv8, ByteTrack and Supervision to detect, track and count objects. 🔥 Subscribe, and stay up to date with our latest YouTube videos!
🧹 code quality
We provide two handy commands inside the Makefile, namely:
make styleto format the codemake check_code_qualityto check code quality (PEP8 basically)
So far, there is no types checking with mypy. See issue.
🧪 tests
pytests is used to run our tests.