143 lines
4.5 KiB
Markdown
143 lines
4.5 KiB
Markdown
---
|
|
template: index.html
|
|
comments: true
|
|
hide:
|
|
- navigation
|
|
- toc
|
|
---
|
|
|
|
<div class="md-typeset">
|
|
<h1></h1>
|
|
</div>
|
|
|
|
<div align="center" id="logo">
|
|
<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>
|
|
|
|
## 👋 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.8**](https://www.python.org/) environment.
|
|
|
|
!!! example "pip install (recommended)"
|
|
=== "pip"
|
|
[](https://badge.fury.io/py/supervision)
|
|
[](https://pypistats.org/packages/supervision)
|
|
[](https://github.com/roboflow/supervision/blob/main/LICENSE.md)
|
|
[](https://badge.fury.io/py/supervision)
|
|
|
|
```bash
|
|
pip install 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 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 "."
|
|
```
|
|
|
|
=== "poetry"
|
|
```bash
|
|
# clone repository and navigate to root directory
|
|
git clone https://github.com/roboflow/supervision.git
|
|
cd supervision
|
|
|
|
# setup python environment and activate it
|
|
poetry env use python3.10
|
|
poetry shell
|
|
|
|
# installation
|
|
poetry install
|
|
```
|
|
|
|
## 🚀 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>
|