okooooooo/supervision
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
efbb5e25995dfe71ef0502f139f428ed45a38e92
supervision/docs/index.md
T
Jirka Borovecpre-commit-ci[bot]Copilot
 6149bacc77 Fix and augment relative links in MD files to GitHub blob URLs (#2061) 
* Add script to augment relative links in MD files to GitHub blob URLs
* fix(pre_commit): 🎨 auto format pre-commit hooks
* Add type annotations to `augment_links.py` and update config
* Add `lychee-action` for link checking in CI workflows
* Apply suggestions from code review
* links in README.md

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-02 17:47:59 +01:00

6.1 KiB
Raw Blame History

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 conda-downloads conda-version conda-platforms

    ```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

Reference in new issue View Git Blame Copy Permalink