2024-01-17 12:11:31 +01:00
---
2024-02-09 20:12:44 +03:00
template: index.html
2024-01-17 12:11:31 +01:00
comments: true
2024-02-08 17:13:03 +03:00
hide:
- navigation
2024-02-08 17:33:52 +03:00
- toc
2024-01-17 12:11:31 +01:00
---
2024-02-09 20:12:44 +03:00
<div class="md-typeset">
<h1></h1>
</div>
2025-06-17 09:34:23 -04:00
<div align="center" id="logo" style="padding-top: 1rem;">
2024-02-09 20:12:44 +03:00
<a align="center" href="" target="_blank">
<img width="850"
src="https://media.roboflow.com/open-source/supervision/rf-supervision-banner.png?updatedAt=1678995927529">
</a>
2023-01-31 09:36:39 +01:00
</div>
2025-06-17 09:34:23 -04:00
<style>
#hello {
margin: 0;
}
</style>
2023-07-21 23:11:03 +02:00
## ๐ Hello
2023-01-31 09:36:39 +01:00
2023-07-25 13:02:26 +03:00
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!
2023-01-31 09:36:39 +01:00
2024-01-24 17:47:11 +01:00
<video controls>
<source
src="https://media.roboflow.com/traffic_analysis_result.mp4"
type="video/mp4"
>
</video>
2023-07-21 23:11:03 +02:00
## ๐ป Install
2023-02-01 10:28:49 +00:00
2024-03-28 17:53:55 +00:00
You can install `supervision` in a
2025-07-14 20:21:35 +03:00
[**Python>=3.9** ](https://www.python.org/ ) environment.
2023-01-31 09:36:39 +01:00
2024-11-29 19:51:39 +03:00
!!! example "Installation"
=== "pip (recommended)"
2026-02-03 22:00:40 +09:00
2024-09-19 17:37:43 +03:00
[](https://badge.fury.io/py/supervision)
[](https://pypistats.org/packages/supervision)
2026-02-03 01:47:59 +09:00
[](../LICENSE.md)
2024-09-19 17:37:43 +03:00
[](https://badge.fury.io/py/supervision)
2023-07-25 13:02:26 +03:00
2024-03-28 18:53:39 +01:00
```bash
2024-09-19 17:37:43 +03:00
pip install supervision
2024-03-28 18:53:39 +01:00
` ``
2023-07-21 23:11:03 +02:00
2024-11-29 19:51:39 +03:00
=== "poetry"
2026-02-03 22:00:40 +09:00
2024-11-29 19:51:39 +03:00
[](https://badge.fury.io/py/supervision)
[](https://pypistats.org/packages/supervision)
2026-02-03 01:47:59 +09:00
[](../LICENSE.md)
2024-11-29 19:51:39 +03:00
[](https://badge.fury.io/py/supervision)
` ``bash
poetry add supervision
` ``
=== "uv"
2026-02-03 22:00:40 +09:00
2024-11-29 19:51:39 +03:00
[](https://badge.fury.io/py/supervision)
[](https://pypistats.org/packages/supervision)
2026-02-03 01:47:59 +09:00
[](../LICENSE.md)
2024-11-29 19:51:39 +03:00
[](https://badge.fury.io/py/supervision)
` ``bash
uv pip install supervision
` ``
For uv projects:
` ``bash
uv add supervision
` ``
=== "rye"
2026-02-03 22:00:40 +09:00
2024-11-29 19:51:39 +03:00
[](https://badge.fury.io/py/supervision)
[](https://pypistats.org/packages/supervision)
2026-02-03 01:47:59 +09:00
[](../LICENSE.md)
2024-11-29 19:51:39 +03:00
[](https://badge.fury.io/py/supervision)
` ``bash
rye add supervision
` ``
2024-03-28 18:53:39 +01:00
!!! example "conda/mamba install"
2026-02-03 22:00:40 +09:00
2024-03-28 18:53:39 +01:00
=== "conda"
2026-02-03 22:00:40 +09:00
2024-03-28 18:53:39 +01:00
[](https://anaconda.org/conda-forge/supervision) [](https://anaconda.org/conda-forge/supervision) [](https://anaconda.org/conda-forge/supervision) [](https://anaconda.org/conda-forge/supervision)
2023-07-25 13:02:26 +03:00
2024-03-28 18:53:39 +01:00
` ``bash
conda install -c conda-forge supervision
` ``
2023-07-25 13:02:26 +03:00
2024-03-28 18:53:39 +01:00
=== "mamba"
2026-02-03 22:00:40 +09:00
2024-03-28 18:53:39 +01:00
[](https://anaconda.org/conda-forge/supervision) [](https://anaconda.org/conda-forge/supervision) [](https://anaconda.org/conda-forge/supervision) [](https://anaconda.org/conda-forge/supervision)
2023-07-25 13:02:26 +03:00
2024-03-28 18:53:39 +01:00
` ``bash
mamba install -c conda-forge supervision
` ``
2023-07-25 13:02:26 +03:00
2024-03-28 18:53:39 +01:00
!!! example "git clone (for development)"
2026-02-03 22:00:40 +09:00
2024-03-28 18:53:39 +01:00
=== "virtualenv"
2026-02-03 22:00:40 +09:00
2024-03-28 18:53:39 +01:00
` ``bash
# clone repository and navigate to root directory
2024-11-19 17:57:56 +03:00
git clone --depth 1 -b develop https://github.com/roboflow/supervision.git
2024-03-28 18:53:39 +01:00
cd supervision
2023-07-25 13:02:26 +03:00
2024-03-28 18:53:39 +01:00
# setup python environment and activate it
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
2024-03-28 17:55:11 +03:00
2024-09-19 17:37:43 +03:00
# installation
2024-03-28 18:53:39 +01:00
pip install -e "."
` ``
2024-03-28 17:55:11 +03:00
2025-01-09 00:30:45 +03:00
=== "uv"
2026-02-03 22:00:40 +09:00
2024-03-28 18:53:39 +01:00
` ``bash
# clone repository and navigate to root directory
2024-11-19 17:57:56 +03:00
git clone --depth 1 -b develop https://github.com/roboflow/supervision.git
2024-03-28 18:53:39 +01:00
cd supervision
2024-03-28 17:55:11 +03:00
2024-03-28 18:53:39 +01:00
# setup python environment and activate it
2025-01-09 00:30:45 +03:00
uv venv
source .venv/bin/activate
2024-03-28 17:55:11 +03:00
2024-09-19 17:37:43 +03:00
# installation
2025-01-09 00:30:45 +03:00
uv pip install -r pyproject.toml -e . --all-extras
2024-03-28 18:53:39 +01:00
` ``
2024-02-01 22:14:42 +03:00
## ๐ Quickstart
<div class="grid cards" markdown>
2024-09-20 14:50:46 +03:00
- **Detect and Annotate**
2024-02-01 22:14:42 +03:00
2024-09-27 14:17:34 +03:00
---
2024-02-01 22:14:42 +03:00
2024-09-27 14:17:34 +03:00
Annotate predictions from a range of object detection and segmentation models
2024-02-01 22:14:42 +03:00
2024-09-27 14:17:34 +03:00
[:octicons-arrow-right-24: Tutorial](how_to/detect_and_annotate.md)
2024-02-01 22:14:42 +03:00
2024-09-20 14:50:46 +03:00
- **Track Objects**
2024-02-01 22:14:42 +03:00
2024-09-27 14:17:34 +03:00
---
2024-02-01 22:14:42 +03:00
2024-09-27 14:17:34 +03:00
Discover how to enhance video analysis by implementing seamless object tracking
2024-02-01 22:14:42 +03:00
2024-09-27 14:17:34 +03:00
[:octicons-arrow-right-24: Tutorial](how_to/track_objects.md)
2024-02-01 22:14:42 +03:00
2024-09-20 14:50:46 +03:00
- **Detect Small Objects**
2024-03-25 21:11:47 +01:00
2024-09-27 14:17:34 +03:00
---
2024-03-25 21:11:47 +01:00
2024-09-27 14:17:34 +03:00
Learn how to detect small objects in images
2024-03-25 21:11:47 +01:00
2024-09-27 14:17:34 +03:00
[:octicons-arrow-right-24: Tutorial](how_to/detect_small_objects.md)
2024-03-25 21:11:47 +01:00
2024-09-20 14:50:46 +03:00
- **Count Objects Crossing Line**
2024-02-01 22:14:42 +03:00
2024-09-27 14:17:34 +03:00
---
2024-02-01 22:14:42 +03:00
2024-09-27 14:17:34 +03:00
Explore methods to accurately count and analyze objects crossing a predefined line
2024-02-01 22:14:42 +03:00
2024-09-27 14:17:34 +03:00
[:octicons-arrow-right-24: Notebook](https://supervision.roboflow.com/latest/notebooks/count-objects-crossing-the-line/)
2024-09-19 17:47:28 +03:00
2024-09-20 14:50:46 +03:00
- > **Filter Objects in Zone**
2024-02-01 22:14:42 +03:00
2024-09-27 14:17:34 +03:00
---
2024-02-01 22:14:42 +03:00
2024-09-27 14:17:34 +03:00
Master the techniques to selectively filter and focus on objects within a specific zone
2024-07-08 13:56:37 +03:00
2024-09-20 14:50:46 +03:00
- **Cheatsheet**
2024-07-08 13:56:37 +03:00
2024-09-27 14:17:34 +03:00
---
2024-07-08 13:56:37 +03:00
2024-09-27 14:17:34 +03:00
Access a quick reference guide to the most common ` supervision` functions
2024-07-08 13:56:37 +03:00
2024-09-27 14:17:34 +03:00
[:octicons-arrow-right-24: Cheatsheet ](https://roboflow.github.io/cheatsheet-supervision/ )
2024-07-08 13:56:37 +03:00
2024-02-01 22:14:42 +03:00
</div>