Skip to content

Commit

Permalink
Merge pull request #1530 from roboflow/feature/pip-package-configuration
Browse files Browse the repository at this point in the history
fix: 🐞 removal of opencv-python-headless package
  • Loading branch information
LinasKo committed Sep 19, 2024
2 parents c532758 + c9fa3d6 commit 784191a
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 60 deletions.
44 changes: 17 additions & 27 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,15 @@ You can install `supervision` in a

!!! 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.
=== "pip"

```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.
[![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
pip install "supervision[desktop]"
pip install supervision
```

!!! example "conda/mamba install"
Expand Down Expand Up @@ -81,11 +78,8 @@ You can install `supervision` in a
source venv/bin/activate
pip install --upgrade pip

# headless install
# installation
pip install -e "."

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

=== "poetry"
Expand All @@ -99,62 +93,58 @@ You can install `supervision` in a
poetry env use python3.10
poetry shell

# headless install
# installation
poetry install

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

## 🚀 Quickstart

<div class="grid cards" markdown>

- __Detect and Annotate__
- **Detect and Annotate**

---

Annotate predictions from a range of object detection and segmentation models

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

- __Track Objects__
- **Track Objects**

---

Discover how to enhance video analysis by implementing seamless object tracking

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

- __Detect Small Objects__
- **Detect Small Objects**

---

Learn how to detect small objects in images

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

- __Count Objects Crossing Line__

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

---

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

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

- **Filter Objects in Zone**

---

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

- **Cheatsheet**
- **Cheatsheet**

***
---

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

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


</div>
32 changes: 2 additions & 30 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 1 addition & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,14 @@ matplotlib = ">=3.6.0"
pyyaml = ">=5.3"
defusedxml = "^0.7.1"
pillow = ">=9.4"
opencv-python = { version = ">=4.5.5.64", optional = true }
opencv-python-headless = ">=4.5.5.64"
requests = { version = ">=2.26.0,<=2.32.3", optional = true }
tqdm = { version = ">=4.62.3,<=4.66.5", optional = true }
# pandas: picked lowest major version that supports Python 3.8
pandas = { version = ">=2.0.0", optional = true }
pandas-stubs = { version = ">=2.0.0.230412", optional = true }
opencv-python = ">=4.5.5.64"

[tool.poetry.extras]
desktop = ["opencv-python"]
assets = ["requests", "tqdm"]
metrics = ["pandas", "pandas-stubs"]

Expand Down

0 comments on commit 784191a

Please sign in to comment.