xiaoxue_admin
/
supervision
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
supervision/docs/index.md

4.6 KiB
Raw Blame History

template comments hide
index.html true
navigation
toc

👋 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.8 environment.

!!! example "pip install (recommended)"

=== "headless"
    The headless installation of `supervision` is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications.

    ```bash
    pip install supervision
    ```

=== "desktop"
    If you require the full version of `supervision` with GUI support you can install the desktop version. This version includes the GUI components of OpenCV, allowing you to display images and videos on the screen.

    ```bash
    pip install "supervision[desktop]"
    ```

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

    # headless install
    pip install -e "."

    # desktop install
    pip install -e ".[desktop]"
    ```

=== "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

    # headless install
    poetry install

    # desktop install
    poetry install --extras "desktop"
    ```

🚀 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

  • 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