Roboflow reusable computer vision tools
Go to file
James Gallagher 4fbec12b06 run linter 2023-02-01 14:37:54 +00:00
.github 🧪 python 3.7 test still fail 2023-01-31 13:50:36 +01:00
docs create stub doc files, refactor docstrings, add placeholders for examples 2023-02-01 10:28:49 +00:00
supervision run linter 2023-02-01 14:37:54 +00:00
test run linter 2023-02-01 14:37:54 +00:00
.gitignore First batch of basic tools: 2023-01-18 19:27:51 +01:00
LICENSE.md
Makefile - 🖌️ draw_line, draw_rectangle, draw_filled_rectangle utils added 2023-01-18 19:42:25 +01:00
README.md Update README.md 2023-01-31 13:58:04 +01:00
mkdocs.yml create stub doc files, refactor docstrings, add placeholders for examples 2023-02-01 10:28:49 +00:00
requirements.txt add requirements.txt 2023-02-01 10:29:00 +00:00
setup.py 🎬 poc of video utils documentation 2023-01-31 09:36:39 +01:00

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!

latest-roboflow-tutorial

🧹 code quality

We provide two handy commands inside the Makefile, namely:

  • make style to format the code
  • make check_code_quality to check code quality (PEP8 basically)

So far, there is no types checking with mypy. See issue.

🧪 tests

pytests is used to run our tests.