wehub-resource-sync
9194ef5abd
Docs/Test Workflow / Test docs build (push) Failing after 0s
Check links & references / links-check (push) Failing after 1s
Pytest/Test Workflow / Import Test and Pytest Run (ubuntu-latest, 3.10) (push) Failing after 0s
Pytest/Test Workflow / Import Test and Pytest Run (ubuntu-latest, 3.11) (push) Failing after 0s
PR Conflict Labeler / main (push) Failing after 2s
Pytest/Test Workflow / Import Test and Pytest Run (ubuntu-latest, 3.12) (push) Failing after 2s
Pytest/Test Workflow / Import Test and Pytest Run (ubuntu-latest, 3.13) (push) Failing after 0s
Pytest/Test Workflow / Build this Package (push) Failing after 5s
Pytest/Test Workflow / Import Test and Pytest Run (macos-latest, 3.10) (push) Has been cancelled
Pytest/Test Workflow / Import Test and Pytest Run (macos-latest, 3.11) (push) Has been cancelled
Pytest/Test Workflow / Import Test and Pytest Run (macos-latest, 3.12) (push) Has been cancelled
Pytest/Test Workflow / Import Test and Pytest Run (macos-latest, 3.13) (push) Has been cancelled
Pytest/Test Workflow / Import Test and Pytest Run (windows-latest, 3.10) (push) Has been cancelled
Pytest/Test Workflow / Import Test and Pytest Run (windows-latest, 3.11) (push) Has been cancelled
Pytest/Test Workflow / Import Test and Pytest Run (windows-latest, 3.12) (push) Has been cancelled
Pytest/Test Workflow / Import Test and Pytest Run (windows-latest, 3.13) (push) Has been cancelled
Pytest/Test Workflow / testing-guardian (push) Has been cancelled
193 lines
7.0 KiB
Markdown
193 lines
7.0 KiB
Markdown
---
|
|
template: index.html
|
|
comments: true
|
|
hide:
|
|
- navigation
|
|
- toc
|
|
description: Open-source Python library providing computer vision tools for annotating detections, tracking objects, counting in zones, and processing datasets.
|
|
---
|
|
|
|
<div class="md-typeset">
|
|
<h1></h1>
|
|
</div>
|
|
|
|
<div align="center" id="logo" style="padding-top: 1rem;">
|
|
<a align="center" href="" target="_blank">
|
|
<img width="850"
|
|
src="https://media.roboflow.com/open-source/supervision/rf-supervision-banner.png?updatedAt=1678995927529">
|
|
</a>
|
|
</div>
|
|
|
|
<style>
|
|
#hello {
|
|
margin: 0;
|
|
}
|
|
</style>
|
|
|
|
## What is Supervision?
|
|
|
|
Supervision is an open-source Python library by Roboflow for building computer vision applications. It provides a unified `Detections` object with converters for supported outputs from Ultralytics, Roboflow Inference, Transformers, SAM, Detectron2, MMDetection, YOLO-NAS, PaddleDet, NCNN, Azure AI Vision, and VLM parsers.
|
|
|
|
With Supervision you can annotate images and video with bounding boxes, masks, and labels; track objects across frames with persistent IDs; count and filter detections inside polygon zones; load and convert datasets between YOLO, COCO, and Pascal VOC formats; and benchmark model performance with mAP and confusion matrices.
|
|
|
|
Supervision is MIT licensed, has 38,000+ GitHub stars, and over 1 million monthly PyPI downloads. It is developed in public on GitHub for production computer vision workflows.
|
|
|
|
## 👋 Hello
|
|
|
|
We write your reusable computer vision tools. Whether you need to load your dataset from your hard drive, draw detections on an image or video, or count how many detections are in a zone. You can count on us!
|
|
|
|
<video controls>
|
|
<source
|
|
src="https://media.roboflow.com/traffic_analysis_result.mp4"
|
|
type="video/mp4"
|
|
>
|
|
</video>
|
|
|
|
## 💻 Install
|
|
|
|
You can install `supervision` in a [**Python>=3.10**](https://www.python.org/) environment.
|
|
|
|
!!! example "Installation"
|
|
|
|
=== "pip (recommended)"
|
|
|
|
[](https://badge.fury.io/py/supervision) [](https://pypistats.org/packages/supervision) [](../LICENSE.md) [](https://badge.fury.io/py/supervision)
|
|
|
|
```bash
|
|
pip install supervision
|
|
```
|
|
|
|
=== "poetry"
|
|
|
|
[](https://badge.fury.io/py/supervision) [](https://pypistats.org/packages/supervision) [](../LICENSE.md) [](https://badge.fury.io/py/supervision)
|
|
|
|
```bash
|
|
poetry add supervision
|
|
```
|
|
|
|
=== "uv"
|
|
|
|
[](https://badge.fury.io/py/supervision) [](https://pypistats.org/packages/supervision) [](../LICENSE.md) [](https://badge.fury.io/py/supervision)
|
|
|
|
```bash
|
|
uv pip install supervision
|
|
```
|
|
|
|
For uv projects:
|
|
|
|
```bash
|
|
uv add supervision
|
|
```
|
|
|
|
=== "rye"
|
|
|
|
[](https://badge.fury.io/py/supervision) [](https://pypistats.org/packages/supervision) [](../LICENSE.md) [](https://badge.fury.io/py/supervision)
|
|
|
|
```bash
|
|
rye add supervision
|
|
```
|
|
|
|
!!! example "conda/mamba install"
|
|
|
|
=== "conda"
|
|
|
|
[](https://anaconda.org/conda-forge/supervision) [](https://anaconda.org/conda-forge/supervision) [](https://anaconda.org/conda-forge/supervision) [](https://anaconda.org/conda-forge/supervision)
|
|
|
|
```bash
|
|
conda install -c conda-forge supervision
|
|
```
|
|
|
|
=== "mamba"
|
|
|
|
[](https://anaconda.org/conda-forge/supervision) [](https://anaconda.org/conda-forge/supervision) [](https://anaconda.org/conda-forge/supervision) [](https://anaconda.org/conda-forge/supervision)
|
|
|
|
```bash
|
|
mamba install -c conda-forge supervision
|
|
```
|
|
|
|
!!! example "git clone (for development)"
|
|
|
|
=== "virtualenv"
|
|
|
|
```bash
|
|
# clone repository and navigate to root directory
|
|
git clone --depth 1 -b develop https://github.com/roboflow/supervision.git
|
|
cd supervision
|
|
|
|
# setup python environment and activate it
|
|
python3 -m venv venv
|
|
source venv/bin/activate
|
|
pip install --upgrade pip
|
|
|
|
# installation
|
|
pip install -e "."
|
|
```
|
|
|
|
=== "uv"
|
|
|
|
```bash
|
|
# clone repository and navigate to root directory
|
|
git clone --depth 1 -b develop https://github.com/roboflow/supervision.git
|
|
cd supervision
|
|
|
|
# setup python environment and activate it
|
|
uv venv
|
|
source .venv/bin/activate
|
|
|
|
# installation
|
|
uv pip install -r pyproject.toml -e . --all-extras
|
|
|
|
```
|
|
|
|
## 🚀 Quickstart
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- **Detect and Annotate**
|
|
|
|
---
|
|
|
|
Annotate predictions from a range of object detection and segmentation models
|
|
|
|
[:octicons-arrow-right-24: Tutorial](how_to/detect_and_annotate.md)
|
|
|
|
- **Track Objects**
|
|
|
|
---
|
|
|
|
Discover how to enhance video analysis by implementing seamless object tracking
|
|
|
|
[:octicons-arrow-right-24: Tutorial](how_to/track_objects.md)
|
|
|
|
- **Detect Small Objects**
|
|
|
|
---
|
|
|
|
Learn how to detect small objects in images
|
|
|
|
[:octicons-arrow-right-24: Tutorial](how_to/detect_small_objects.md)
|
|
|
|
- **Count Objects Crossing Line**
|
|
|
|
---
|
|
|
|
Explore methods to accurately count and analyze objects crossing a predefined line
|
|
|
|
[:octicons-arrow-right-24: Notebook](https://supervision.roboflow.com/latest/notebooks/count-objects-crossing-the-line/)
|
|
|
|
- > **Filter Objects in Zone**
|
|
|
|
---
|
|
|
|
Master the techniques to selectively filter and focus on objects within a specific zone
|
|
|
|
- **Cheatsheet**
|
|
|
|
---
|
|
|
|
Access a quick reference guide to the most common `supervision` functions
|
|
|
|
[:octicons-arrow-right-24: Cheatsheet](https://roboflow.github.io/cheatsheet-supervision/)
|
|
|
|
</div>
|