Update README.md to enhance features and add examples by Borda · Pull Request #2065 · roboflow/supervision

Borda · 2026-01-09T10:37:32Z

This pull request significantly improves the README.md by making the documentation more user-friendly and informative. The main enhancements include the addition of a "Key Features" section, new code examples for core functionalities, improved demo links, and minor formatting updates for clarity and consistency.

Documentation improvements:

Added a new "Key Features" section highlighting major capabilities such as model-agnostic connectors, annotators, object tracking, zone counting, metrics, dataset utilities, and production-ready tools.
Introduced new code examples for object tracking, line and polygon zones, and metrics to help users quickly understand and implement these features.

Demo and formatting updates:

Replaced raw video and image demo links with labeled, clickable demo links for a cleaner presentation in the "built with supervision" section.
Simplified and standardized the HTML image tag formatting in the social and documentation links section for better readability and maintainability.

Copilot

Pull request overview

This pull request enhances the README.md documentation by adding comprehensive feature highlights, usage examples for key functionalities, and improving formatting consistency. The changes make the documentation more accessible and informative for users.

Added "Key Features" and "Why Supervision?" sections to highlight the library's capabilities and value proposition
Introduced practical code examples for tracking, line zones, polygon zones, and metrics
Converted embedded media links to labeled hyperlinks for cleaner presentation
Consolidated HTML formatting for social media icons

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

SkalskiP · 2026-01-12T09:34:52Z

+## 🌟 Key Features
+- 🚀 **Model Agnostic**: Connectors for Ultralytics YOLO, Transformers, MMDetection, Roboflow Inference &amp; more ([docs](https://supervision.roboflow.com/latest/detection/core/#detections))
+- 🎨 **25+ Annotators**: Box, Label, Mask, Trace, HeatMap, Icon, Blur, Pixelate, Halo &amp; many others ([docs](https://supervision.roboflow.com/latest/detection/annotators/))
+- 🏃‍♂️ **Object Tracking**: ByteTracker &amp; more for multi-object tracking ([docs](https://supervision.roboflow.com/latest/trackers/byte_tracker/))
+- 📏 **Line &amp; Polygon Zones**: Count/filter objects crossing lines or in polygons
+- 📊 **Metrics**: mAP, Precision, Recall, F1 Score ([docs](https://supervision.roboflow.com/latest/metrics/mean_average_precision/))
+- 🗂️ **Datasets**: Load, split, convert (COCO, YOLO, Pascal VOC, etc.) ([docs](https://supervision.roboflow.com/latest/datasets/core/))
+- 🔧 **Utils**: NMS/IoU filters, geometry primitives, drawing helpers
+
+## 🚀 Why Supervision?
+- ⏱️ **Accelerate Development**: Ready-to-use utilities for annotations, tracking, zones, metrics – skip boilerplate code.
+- 🤖 **Model Agnostic**: Integrates seamlessly with YOLO, Transformers, MMDetection, Roboflow Inference &amp; more.
+- ⚡ **Lightweight**: Minimal deps (numpy, opencv), no ML frameworks needed, optimized for speed.
+- 🏗️ **Production-Ready**: Robust, battle-tested tools used in Roboflow products.
+- 📚 **Rich Ecosystem**: 25+ annotators, full docs, tutorials, notebooks, active Discord ([join here](https://discord.gg/GbfgXGJ8Bk)).


This feels very AI generated. Let's remove all the emojis other than ones in headers. All headers were lower case, so lets keep things consistant.

I put all emojis there on purpose; it makes the reading nicer
but fine to make it boring text again :)

it is fine to write it just once

SkalskiP · 2026-01-12T09:36:18Z

+### 🏃‍♂️ tracking
+Track objects across frames with state-of-the-art trackers like ByteTrack.
+
+```python
+import supervision as sv
+
+byte_tracker = sv.ByteTracker()
+tracks = byte_tracker.update_with_detections(detections=detections)
+```
+Use `sv.IdAnnotator()` to visualize track `id`.
+
+### 📏 line zone
+Count objects crossing a line.
+
+```python
+line_zone = sv.LineZone(start=sv.Point(0, 0), end=sv.Point(640, 640))
+line_zone_annotator = sv.LineZoneAnnotator()
+
+line_zone.trigger(detections=detections)
+annotated_frame = line_zone_annotator.annotate(scene=image, line_counter=line_zone)
+```


Tracking is still here, but with next release of trackers that will add ByteTracker, we plan to deprecate ByteTracker from supervision.

SkalskiP · 2026-01-12T09:38:02Z

+annotated_frame = line_zone_annotator.annotate(scene=image, line_counter=line_zone)
+```
+
+### 🔶 polygon zone


let's not go to hard on emojis + keep things consistant ### headers don't have emojis

it is fine to write it just once

SkalskiP · 2026-01-12T09:38:08Z

+annotated_frame = polygon_zone_annotator.annotate(scene=image, polygon_zone=polygon_zone)
+```
+
+### 📊 metrics


let's not go to hard on emojis + keep things consistant ### headers don't have emojis

it is fine to write it just once

SkalskiP · 2026-01-12T09:39:28Z

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

+## 🌟 Key Features
+- 🚀 **Model Agnostic**: Connectors for Ultralytics YOLO, Transformers, MMDetection, Roboflow Inference &amp; more ([docs](https://supervision.roboflow.com/latest/detection/core/#detections))


Let's alweays put Roboflow Inference as #1 when we list frameworks and libraries like this.

SkalskiP · 2026-01-12T09:39:56Z

+
+## 🚀 Why Supervision?
+- ⏱️ **Accelerate Development**: Ready-to-use utilities for annotations, tracking, zones, metrics – skip boilerplate code.
+- 🤖 **Model Agnostic**: Integrates seamlessly with YOLO, Transformers, MMDetection, Roboflow Inference &amp; more.


Let's alweays put Roboflow Inference as #1 when we list frameworks and libraries like this.

SkalskiP · 2026-01-12T09:53:18Z

This is a strong direction. A few high level notes:

We should remove the key features section and move the content into quickstart. Right now it feels repetitive because we describe the same ideas in two places. I want the README to stay as short as possible while still serving as a solid entry point for exploration. Expanding quickstart with the features you listed, plus more examples and links to the docs, feels right.
We should remove the why Supervision? section and merge it with hello. We can rename hello to something more descriptive, like what’s this? or simply supervision. I do not want this section to exceed five sentences. The points you added in why Supervision? fit there well.
As a follow up, let’s create a one to two sentence version of hello and replace the current tagline “We write your reusable computer vision tools. 💜” as you suggested.

Borda · 2026-01-12T10:01:13Z

Okay, as it seems you requested changes or negated the purpose of this PR, I'll close it. However, please suggest some other improvements to the README so the user can see the value of this package, as it is missing right now.

Right now it feels repetitive because we describe the same ideas in two places.

It could be for you, as you know the package, but for anyone else, if I dont see the value early in the readme, I just leave and find something else. The features serve as content, you also dont complain that the book has a chapter listed in content and later in the body...

Update README.md to enhance feature descriptions and add usage examples

54ae5b1

Copilot AI review requested due to automatic review settings January 9, 2026 10:37

Borda requested a review from SkalskiP as a code owner January 9, 2026 10:37

Borda changed the title ~~Update README.md to enhance feature descriptions and add usage examples~~ Update README.md to enhance features and add examples Jan 9, 2026

Copilot started reviewing on behalf of Borda January 9, 2026 10:38 View session

Copilot AI reviewed Jan 9, 2026

View reviewed changes

Comment thread README.md Outdated

Comment thread README.md

Borda and others added 3 commits January 9, 2026 11:41

Apply suggestions from code review

0578555

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

update

c389fb9

update

7eb5870

SkalskiP requested changes Jan 12, 2026

View reviewed changes

Borda closed this Jan 12, 2026

Borda deleted the update/readme branch April 13, 2026 10:02

Uh oh!

Conversation

Borda commented Jan 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SkalskiP commented Jan 12, 2026

Uh oh!

Borda commented Jan 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants