supervision/docs/index.md

template, comments, hide

template	comments	hide
index.html	true	navigation toc

<style> #hello { margin: 0; } </style>

👋 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!

💻 Install

You can install supervision in a Python>=3.9 environment.

!!! example "Installation"

=== "pip (recommended)"

    [![version](https://badge.fury.io/py/supervision.svg)](https://badge.fury.io/py/supervision)
    [![downloads](https://img.shields.io/pypi/dm/supervision)](https://pypistats.org/packages/supervision)
    [![license](https://img.shields.io/pypi/l/supervision)](../LICENSE.md)
    [![python-version](https://img.shields.io/pypi/pyversions/supervision)](https://badge.fury.io/py/supervision)

    ```bash
    pip install supervision
    ```

=== "poetry"

    [![version](https://badge.fury.io/py/supervision.svg)](https://badge.fury.io/py/supervision)
    [![downloads](https://img.shields.io/pypi/dm/supervision)](https://pypistats.org/packages/supervision)
    [![license](https://img.shields.io/pypi/l/supervision)](../LICENSE.md)
    [![python-version](https://img.shields.io/pypi/pyversions/supervision)](https://badge.fury.io/py/supervision)

    ```bash
    poetry add supervision
    ```

=== "uv"

    [![version](https://badge.fury.io/py/supervision.svg)](https://badge.fury.io/py/supervision)
    [![downloads](https://img.shields.io/pypi/dm/supervision)](https://pypistats.org/packages/supervision)
    [![license](https://img.shields.io/pypi/l/supervision)](../LICENSE.md)
    [![python-version](https://img.shields.io/pypi/pyversions/supervision)](https://badge.fury.io/py/supervision)

    ```bash
    uv pip install supervision
    ```

    For uv projects:

    ```bash
    uv add supervision
    ```

=== "rye"

    [![version](https://badge.fury.io/py/supervision.svg)](https://badge.fury.io/py/supervision)
    [![downloads](https://img.shields.io/pypi/dm/supervision)](https://pypistats.org/packages/supervision)
    [![license](https://img.shields.io/pypi/l/supervision)](../LICENSE.md)
    [![python-version](https://img.shields.io/pypi/pyversions/supervision)](https://badge.fury.io/py/supervision)

    ```bash
    rye add supervision
    ```

!!! example "conda/mamba install"

=== "conda"

    [![conda-recipe](https://img.shields.io/badge/recipe-supervision-green.svg)](https://anaconda.org/conda-forge/supervision) [![conda-downloads](https://img.shields.io/conda/dn/conda-forge/supervision.svg)](https://anaconda.org/conda-forge/supervision) [![conda-version](https://img.shields.io/conda/vn/conda-forge/supervision.svg)](https://anaconda.org/conda-forge/supervision) [![conda-platforms](https://img.shields.io/conda/pn/conda-forge/supervision.svg)](https://anaconda.org/conda-forge/supervision)

    ```bash
    conda install -c conda-forge supervision
    ```

=== "mamba"

    [![mamba-recipe](https://img.shields.io/badge/recipe-supervision-green.svg)](https://anaconda.org/conda-forge/supervision) [![mamba-downloads](https://img.shields.io/conda/dn/conda-forge/supervision.svg)](https://anaconda.org/conda-forge/supervision) [![mamba-version](https://img.shields.io/conda/vn/conda-forge/supervision.svg)](https://anaconda.org/conda-forge/supervision) [![mamba-platforms](https://img.shields.io/conda/pn/conda-forge/supervision.svg)](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

• Detect and Annotate

  ---

  Annotate predictions from a range of object detection and segmentation models

  :octicons-arrow-right-24: Tutorial

• Track Objects

  ---

  Discover how to enhance video analysis by implementing seamless object tracking

  :octicons-arrow-right-24: Tutorial

• Detect Small Objects

  ---

  Learn how to detect small objects in images

  :octicons-arrow-right-24: Tutorial

• Count Objects Crossing Line

  ---

  Explore methods to accurately count and analyze objects crossing a predefined line

  :octicons-arrow-right-24: Notebook

• 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