Skip to content

docs: improve homepage with metadata, accessibility, and better layout #1986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aman689 wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

docs: improve homepage with metadata, accessibility, and better layout #1986

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d71e090
docs: improve homepage with metadata, accessibility, and better layout
aman689 Oct 9, 2025
09645c3
fix(pre_commit): 🎨 auto format pre-commit hooks
pre-commit-ci[bot] Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 50 additions & 34 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
---
template: index.html
title: Supervision – Open Source Computer Vision Toolkit
description: Supervision is a lightweight open-source computer vision toolkit. Easily load datasets, draw detections, count objects, and analyze videos using Python.
comments: true
hide:
- navigation
- toc
---

<div class="md-typeset">
<h1></h1>
<h1 align="center">Supervision – Open Source Computer Vision Toolkit</h1>
</div>

<div align="center" id="logo" style="padding-top: 1rem;">
<a align="center" href="" target="_blank">
<img width="850"
src="https://media.roboflow.com/open-source/supervision/rf-supervision-banner.png?updatedAt=1678995927529">
<a href="https://github.com/roboflow/supervision" target="_blank">
<img
width="850"
src="https://media.roboflow.com/open-source/supervision/rf-supervision-banner.png?updatedAt=1678995927529"
alt="Supervision: Open Source Computer Vision Toolkit Banner"
>
</a>
</div>

Expand All @@ -25,7 +30,8 @@ hide:

## 👋 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!
We build **reusable computer vision tools** to make your workflow faster and easier.
Whether you need to **load datasets**, **visualize detections**, or **count objects in specific zones** — you can count on us!

<video controls>
<source
Expand All @@ -34,10 +40,12 @@ We write your reusable computer vision tools. Whether you need to load your data
>
</video>

---

## 💻 Install

You can install `supervision` in a
[**Python>=3.9**](https://www.python.org/) environment.
[**Python ≥ 3.9**](https://www.python.org/) environment.

!!! example "Installation"

Expand All @@ -52,21 +60,11 @@ You can install `supervision` in a
```

=== "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)](https://github.com/roboflow/supervision/blob/main/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)](https://github.com/roboflow/supervision/blob/main/LICENSE.md)
[![python-version](https://img.shields.io/pypi/pyversions/supervision)](https://badge.fury.io/py/supervision)

```bash
uv pip install supervision
```
Expand All @@ -78,27 +76,22 @@ You can install `supervision` in a
```

=== "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)](https://github.com/roboflow/supervision/blob/main/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)
[![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
```
Expand Down Expand Up @@ -131,9 +124,22 @@ You can install `supervision` in a

# installation
uv pip install -r pyproject.toml -e . --all-extras

```

---

## 📘 Documentation Overview

Explore essential topics to get started with Supervision:

- [Getting Started Guide](getting_started.md)
- [API Reference](reference/index.md)
- [Contributing Guidelines](https://github.com/roboflow/supervision/blob/main/CONTRIBUTING.md)
- [Examples Repository](https://github.com/roboflow/notebooks)
- [Changelog](https://github.com/roboflow/supervision/releases)

---

## 🚀 Quickstart

<div class="grid cards" markdown>
Expand All @@ -142,46 +148,56 @@ You can install `supervision` in a

---

Annotate predictions from a range of object detection and segmentation models
Annotate predictions from various object detection and segmentation models.

[:octicons-arrow-right-24: Tutorial](how_to/detect_and_annotate.md)

- **Track Objects**

---

Discover how to enhance video analysis by implementing seamless object tracking
Enhance video analysis by implementing seamless object tracking.

[:octicons-arrow-right-24: Tutorial](how_to/track_objects.md)

- **Detect Small Objects**

---

Learn how to detect small objects in images
Learn how to detect small objects in images effectively.

[:octicons-arrow-right-24: Tutorial](how_to/detect_small_objects.md)

- **Count Objects Crossing Line**

---

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

[:octicons-arrow-right-24: Notebook](https://supervision.roboflow.com/latest/notebooks/count-objects-crossing-the-line/)

- > **Filter Objects in Zone**
- **Filter Objects in Zone**

---

Master the techniques to selectively filter and focus on objects within a specific zone
Master the techniques to selectively filter and focus on objects within a specific zone.

[:octicons-arrow-right-24: Tutorial](how_to/filter_objects_in_zone.md)

- **Cheatsheet**

---

Access a quick reference guide to the most common `supervision` functions
Access a quick reference guide to the most common `supervision` functions.

[:octicons-arrow-right-24: Cheatsheet](https://roboflow.github.io/cheatsheet-supervision/)

</div>

---

## 💬 Join the Community

Have questions or ideas? Join us:
- 💻 [GitHub Discussions](https://github.com/roboflow/supervision/discussions)
- 🐦 [Follow Roboflow on X (Twitter)](https://twitter.com/roboflow)
- 💬 [Discord Community](https://discord.gg/roboflow)