Roboflow reusable computer vision tools
Go to file
SkalskiP d4a2adde9e Merge remote-tracking branch 'origin/feature/add-initial-docs' into feature/add-initial-docs
# Conflicts:
#	.github/workflows/test.yml
2023-01-31 10:02:09 +01:00
.github/workflows 🧪 tests 2023-01-31 10:01:52 +01:00
docs 🎬 poc of video utils documentation 2023-01-31 09:36:39 +01:00
supervision 🖤 make black happy 2023-01-31 09:44:32 +01:00
test ✏️ first iteration of Detections and BoxAnnotator classes added 2023-01-19 00:12:19 +01:00
.gitignore First batch of basic tools: 2023-01-18 19:27:51 +01:00
LICENSE.md ⓒ Add project license 2022-11-28 19:41:28 +01:00
Makefile - 🖌️ draw_line, draw_rectangle, draw_filled_rectangle utils added 2023-01-18 19:42:25 +01:00
README.md 🎬 poc of video utils documentation 2023-01-31 09:36:39 +01:00
mkdocs.yml 🎬 poc of video utils documentation 2023-01-31 09:36:39 +01: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]"

🎬 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.

🪪

Supervision is available under the MIT license - see the LICENSE file for details.