Skip to main content

A set of easy-to-use utils that will come in handy in any Computer Vision project

Project description

👋 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

Pip install the supervision package in a Python>=3.8 environment.

pip install supervision

Read more about desktop, headless, and local installation in our guide.

🔥 quickstart

models

Supervision was designed to be model agnostic. Just plug in any classification, detection, or segmentation model. For your convenience, we have created connectors for the most popular libraries like Ultralytics, Transformers, or MMDetection.

>>> import cv2
>>> import supervision as sv
>>> from ultralytics import YOLO

>>> image = cv2.imread(...)
>>> model = YOLO('yolov8s.pt')
>>> result = model(image)[0]
>>> detections = sv.Detections.from_ultralytics(result)

>>> len(detections)
5

annotators

Supervision offers a wide range of highly customizable annotators, allowing you to compose the perfect visualization for your use case.

>>> import cv2
>>> import supervision as sv

>>> image = cv2.imread(...)
>>> detections = sv.Detections(...)

>>> bounding_box_annotator = sv.BoundingBoxAnnotator()
>>> annotated_frame = bounding_box_annotator.annotate(
...     scene=image.copy(),
...     detections=detections
... )

https://github.com/roboflow/supervision/assets/26109316/691e219c-0565-4403-9218-ab5644f39bce

datasets

Supervision provides a set of utils that allow you to load, split, merge, and save datasets in one of the supported formats.

>>> import supervision as sv

>>> dataset = sv.DetectionDataset.from_yolo(
...     images_directory_path=...,
...     annotations_directory_path=...,
...     data_yaml_path=...
... )

>>> dataset.classes
['dog', 'person']

>>> len(dataset)
1000
👉 more dataset utils
  • load

    >>> dataset = sv.DetectionDataset.from_yolo(
    ...     images_directory_path=...,
    ...     annotations_directory_path=...,
    ...     data_yaml_path=...
    ... )
    
    >>> dataset = sv.DetectionDataset.from_pascal_voc(
    ...     images_directory_path=...,
    ...     annotations_directory_path=...
    ... )
    
    >>> dataset = sv.DetectionDataset.from_coco(
    ...     images_directory_path=...,
    ...     annotations_path=...
    ... )
    
  • split

    >>> train_dataset, test_dataset = dataset.split(split_ratio=0.7)
    >>> test_dataset, valid_dataset = test_dataset.split(split_ratio=0.5)
    
    >>> len(train_dataset), len(test_dataset), len(valid_dataset)
    (700, 150, 150)
    
  • merge

    >>> ds_1 = sv.DetectionDataset(...)
    >>> len(ds_1)
    100
    >>> ds_1.classes
    ['dog', 'person']
    
    >>> ds_2 = sv.DetectionDataset(...)
    >>> len(ds_2)
    200
    >>> ds_2.classes
    ['cat']
    
    >>> ds_merged = sv.DetectionDataset.merge([ds_1, ds_2])
    >>> len(ds_merged)
    300
    >>> ds_merged.classes
    ['cat', 'dog', 'person']
    
  • save

    >>> dataset.as_yolo(
    ...     images_directory_path=...,
    ...     annotations_directory_path=...,
    ...     data_yaml_path=...
    ... )
    
    >>> dataset.as_pascal_voc(
    ...     images_directory_path=...,
    ...     annotations_directory_path=...
    ... )
    
    >>> dataset.as_coco(
    ...     images_directory_path=...,
    ...     annotations_path=...
    ... )
    
  • convert

    >>> sv.DetectionDataset.from_yolo(
    ...     images_directory_path=...,
    ...     annotations_directory_path=...,
    ...     data_yaml_path=...
    ... ).as_pascal_voc(
    ...     images_directory_path=...,
    ...     annotations_directory_path=...
    ... )
    

🎬 tutorials

Traffic Analysis with YOLOv8 and ByteTrack - Vehicle Detection and Tracking Traffic Analysis with YOLOv8 and ByteTrack - Vehicle Detection and Tracking

Created: 6 Sep 2023 | Updated: 6 Sep 2023

In this video, we explore real-time traffic analysis using YOLOv8 and ByteTrack to detect and track vehicles on aerial images. Harnessing the power of Python and Supervision, we delve deep into assigning cars to specific entry zones and understanding their direction of movement. By visualizing their paths, we gain insights into traffic flow across bustling roundabouts...


SAM - Segment Anything Model by Meta AI: Complete Guide SAM - Segment Anything Model by Meta AI: Complete Guide

Created: 11 Apr 2023 | Updated: 11 Apr 2023

Discover the incredible potential of Meta AI's Segment Anything Model (SAM)! We dive into SAM, an efficient and promptable model for image segmentation, which has revolutionized computer vision tasks. With over 1 billion masks on 11M licensed and privacy-respecting images, SAM's zero-shot performance is often competitive with or even superior to prior fully supervised results...

💜 built with supervision

Did you build something cool using supervision? Let us know!

https://user-images.githubusercontent.com/26109316/207858600-ee862b22-0353-440b-ad85-caa0c4777904.mp4

https://github.com/roboflow/supervision/assets/26109316/c9436828-9fbf-4c25-ae8c-60e9c81b3900

📚 documentation

Visit our documentation page to learn how supervision can help you build computer vision applications faster and more reliably.

🏆 contribution

We love your input! Please see our contributing guide to get started. Thank you 🙏 to all our contributors!


Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

supervision-0.17.1rc1.tar.gz (66.1 kB view details)

Uploaded Source

Built Distribution

supervision-0.17.1rc1-py3-none-any.whl (77.6 kB view details)

Uploaded Python 3

File details

Details for the file supervision-0.17.1rc1.tar.gz.

File metadata

  • Download URL: supervision-0.17.1rc1.tar.gz
  • Upload date:
  • Size: 66.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for supervision-0.17.1rc1.tar.gz
Algorithm Hash digest
SHA256 2ec89f54f34aace7020e4d07d0a5d4a2ce5821fb407298776695f598fa4ec140
MD5 b78e7add6dd7b0697034da895ae9debd
BLAKE2b-256 63bc1171d0c906965542354d2dd143f96ebfa5105fa31cf660813192036affe9

See more details on using hashes here.

File details

Details for the file supervision-0.17.1rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for supervision-0.17.1rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 3352f2b645cd4edcc7c733f874a66a9bdb600c76c3fe680ed4bf79d97f53cafb
MD5 87bbd341c48473c1a5700db45716d73e
BLAKE2b-256 caac42364086569dea9d00b220ca3e72d28fd4e4f78c5349379ffe6cc7d6d8f6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page