| template | index.html | ||
|---|---|---|---|
| comments | true | ||
| hide |
|
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!
You can install supervision in a
Python>=3.9 environment.
!!! example "Installation"
=== "pip (recommended)"
[](https://badge.fury.io/py/supervision)
[](https://pypistats.org/packages/supervision)
[](../LICENSE.md)
[](https://badge.fury.io/py/supervision)
Supervision requires OpenCV. Choose the variant that best fits your needs:
⚠️ **Important**: Only install one OpenCV variant at a time. The different `opencv-python` packages (standard, contrib, headless, etc.) are mutually exclusive and cannot coexist in the same environment.
```bash
# Recommended for servers (no GUI)
pip install supervision[headless]
```
```bash
# For desktop applications (includes GUI support)
pip install supervision[desktop]
```
```bash
# For desktop with extra modules (e.g., CSRT tracker)
pip install supervision[desktop-contrib]
```
```bash
# For servers with extra modules (no GUI)
pip install supervision[headless-contrib]
```
If you already have OpenCV installed:
```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
# With headless OpenCV (recommended for servers)
poetry add supervision[headless]
```
```bash
# With desktop OpenCV (includes GUI)
poetry add supervision[desktop]
```
```bash
# For desktop with extra modules (e.g., CSRT tracker)
poetry add supervision[desktop-contrib]
```
```bash
# For servers with extra modules (no GUI)
poetry add supervision[headless-contrib]
```
=== "uv"
[](https://badge.fury.io/py/supervision)
[](https://pypistats.org/packages/supervision)
[](../LICENSE.md)
[](https://badge.fury.io/py/supervision)
```bash
# With headless OpenCV (recommended for servers)
uv pip install supervision[headless]
```
```bash
# For desktop applications (includes GUI support)
uv pip install supervision[desktop]
```
```bash
# For desktop with extra modules (e.g., CSRT tracker)
uv pip install supervision[desktop-contrib]
```
```bash
# For servers with extra modules (no GUI)
uv pip install supervision[headless-contrib]
```
If you already have OpenCV installed:
```bash
uv pip install supervision
```
For uv projects:
```bash
uv add supervision --extra headless
```
=== "rye"
[](https://badge.fury.io/py/supervision)
[](https://pypistats.org/packages/supervision)
[](../LICENSE.md)
[](https://badge.fury.io/py/supervision)
```bash
# With headless OpenCV (recommended for servers)
rye add supervision --features headless
```
```bash
# For desktop applications (includes GUI support)
rye add supervision --features desktop
```
```bash
# For desktop with extra modules (e.g., CSRT tracker)
rye add supervision --features desktop-contrib
```
```bash
# For servers with extra modules (no GUI)
rye add supervision --features headless-contrib
```
!!! 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
```
-
Detect and Annotate
Annotate predictions from a range of object detection and segmentation models
-
Track Objects
Discover how to enhance video analysis by implementing seamless object tracking
-
Detect Small Objects
Learn how to detect small objects in images
-
Count Objects Crossing Line
Explore methods to accurately count and analyze objects crossing a predefined 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
supervisionfunctions