317 lines
11 KiB
Markdown
317 lines
11 KiB
Markdown
<div align="center">
|
|
<p>
|
|
<a align="center" href="" target="_blank">
|
|
<img
|
|
width="100%"
|
|
src="https://media.roboflow.com/open-source/supervision/rf-supervision-banner.png?updatedAt=1678995927529"
|
|
>
|
|
</a>
|
|
</p>
|
|
|
|
<br>
|
|
|
|
[](https://badge.fury.io/py/supervision)
|
|
[](https://pypistats.org/packages/supervision)
|
|
[](https://github.com/roboflow/supervision/blob/main/LICENSE.md)
|
|
[](https://badge.fury.io/py/supervision)
|
|
[](https://colab.research.google.com/github/roboflow/supervision/blob/main/demo.ipynb)
|
|
|
|
</div>
|
|
|
|
## 👋 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
|
|
[**3.11>=Python>=3.7**](https://www.python.org/) environment.
|
|
|
|
```bash
|
|
pip install supervision
|
|
```
|
|
|
|
<details close>
|
|
<summary>👉 install from source</summary>
|
|
|
|
```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
|
|
|
|
# install
|
|
pip install -e ".[dev]"
|
|
```
|
|
|
|
</details>
|
|
|
|
## 🔥 quickstart
|
|
|
|
### [detections processing](https://roboflow.github.io/supervision/detection/core/)
|
|
|
|
```python
|
|
>>> import supervision as sv
|
|
>>> from ultralytics import YOLO
|
|
|
|
>>> model = YOLO('yolov8s.pt')
|
|
>>> result = model(IMAGE)[0]
|
|
>>> detections = sv.Detections.from_yolov8(result)
|
|
|
|
>>> len(detections)
|
|
5
|
|
```
|
|
|
|
<details close>
|
|
<summary>👉 more detections utils</summary>
|
|
|
|
- Easily switch inference pipeline between supported object detection / instance segmentation models
|
|
|
|
```python
|
|
>>> import supervision as sv
|
|
>>> from segment_anything import sam_model_registry, SamAutomaticMaskGenerator
|
|
|
|
>>> sam = sam_model_registry[MODEL_TYPE](checkpoint=CHECKPOINT_PATH).to(device=DEVICE)
|
|
>>> mask_generator = SamAutomaticMaskGenerator(sam)
|
|
>>> sam_result = mask_generator.generate(IMAGE)
|
|
>>> detections = sv.Detections.from_sam(sam_result=sam_result)
|
|
```
|
|
|
|
- [Advanced filtering](https://roboflow.github.io/supervision/quickstart/detections/)
|
|
|
|
```python
|
|
>>> detections = detections[detections.class_id == 0]
|
|
>>> detections = detections[detections.confidence > 0.5]
|
|
>>> detections = detections[detections.area > 1000]
|
|
```
|
|
|
|
- Image annotation
|
|
|
|
```python
|
|
>>> import supervision as sv
|
|
|
|
>>> box_annotator = sv.BoxAnnotator()
|
|
>>> annotated_frame = box_annotator.annotate(
|
|
... scene=IMAGE,
|
|
... detections=detections
|
|
... )
|
|
```
|
|
|
|
</details>
|
|
|
|
### [datasets processing](https://roboflow.github.io/supervision/dataset/core/)
|
|
|
|
```python
|
|
>>> 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
|
|
```
|
|
|
|
<details close>
|
|
<summary>👉 more dataset utils</summary>
|
|
|
|
- Load object detection / instance segmentation datasets in one of supported formats
|
|
|
|
```python
|
|
>>> 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='...'
|
|
... )
|
|
```
|
|
|
|
- Loop over dataset entries
|
|
|
|
```python
|
|
>>> for name, image, labels in dataset:
|
|
... print(labels.xyxy)
|
|
|
|
array([[404. , 719. , 538. , 884.5 ],
|
|
[155. , 497. , 404. , 833.5 ],
|
|
[ 20.154999, 347.825 , 416.125 , 915.895 ]], dtype=float32)
|
|
```
|
|
|
|
- Split dataset for training, testing and validation
|
|
|
|
```python
|
|
>>> 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 multiple datasets together
|
|
|
|
```python
|
|
>>> 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 object detection / instance segmentation datasets in one of supported formats
|
|
|
|
```python
|
|
>>> 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 labels between supported formats
|
|
|
|
```python
|
|
>>> sv.DetectionDataset.from_yolo(
|
|
... images_directory_path='...',
|
|
... annotations_directory_path='...',
|
|
... data_yaml_path='...'
|
|
... ).as_pascal_voc(
|
|
... images_directory_path='...',
|
|
... annotations_directory_path='...'
|
|
... )
|
|
```
|
|
|
|
- Load classification datasets in one of supported formats
|
|
|
|
```python
|
|
>>> cs = sv.ClassificationDataset.from_folder_structure(
|
|
... root_directory_path='...'
|
|
... )
|
|
```
|
|
|
|
- Save classification datasets in one of supported formats
|
|
|
|
```python
|
|
>>> cs.as_folder_structure(
|
|
... root_directory_path='...'
|
|
... )
|
|
```
|
|
|
|
</details>
|
|
|
|
## 🎬 tutorials
|
|
|
|
<p align="left">
|
|
<a href="https://youtu.be/oEQYStnF2l8" title="Accelerate Image Annotation with SAM and Grounding DINO"><img src="https://github.com/SkalskiP/SkalskiP/assets/26109316/ae1ca38e-40b7-4b35-8582-e8ea5de3806e" alt="Accelerate Image Annotation with SAM and Grounding DINO" width="300px" align="left" /></a>
|
|
<a href="https://youtu.be/oEQYStnF2l8" title="Accelerate Image Annotation with SAM and Grounding DINO"><strong>Accelerate Image Annotation with SAM and Grounding DINO</strong></a>
|
|
<div><strong>Created: 20 Apr 2023</strong> | <strong>Updated: 20 Apr 2023</strong></div>
|
|
<br/> Discover how to speed up your image annotation process using Grounding DINO and Segment Anything Model (SAM). Learn how to convert object detection datasets into instance segmentation datasets, and see the potential of using these models to automatically annotate your datasets for real-time detectors like YOLOv8... </p>
|
|
|
|
<br/>
|
|
|
|
<p align="left">
|
|
<a href="https://youtu.be/oEQYStnF2l8" title="SAM - Segment Anything Model by Meta AI: Complete Guide"><img src="https://github.com/SkalskiP/SkalskiP/assets/26109316/6913ff11-53c6-4341-8d90-eaff3023c3fd" alt="SAM - Segment Anything Model by Meta AI: Complete Guide" width="300px" align="left" /></a>
|
|
<a href="https://youtu.be/oEQYStnF2l8" title="SAM - Segment Anything Model by Meta AI: Complete Guide"><strong>SAM - Segment Anything Model by Meta AI: Complete Guide</strong></a>
|
|
<div><strong>Created: 11 Apr 2023</strong> | <strong>Updated: 11 Apr 2023</strong></div>
|
|
<br/> 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... </p>
|
|
|
|
## 📚 documentation
|
|
|
|
Curious how Supervision can help you solve problems on your project? Visit our [documentation](https://roboflow.github.io/supervision) page!
|
|
|
|
## 💜 built with supervision
|
|
|
|
You built something cool using supervision? [Let us know!](https://github.com/roboflow/supervision/discussions/categories/built-with-supervision)
|
|
|
|
## 🏆 contribution
|
|
|
|
We love your input! Please see our [contributing guide](https://github.com/roboflow/supervision/blob/main/CONTRIBUTING.md) to get started. Thank you 🙏 to all our contributors!
|
|
|
|
<br>
|
|
|
|
<div align="center">
|
|
|
|
<div align="center">
|
|
<a href="https://youtube.com/roboflow">
|
|
<img
|
|
src="https://media.roboflow.com/notebooks/template/icons/purple/youtube.png?ik-sdk-version=javascript-1.4.3&updatedAt=1672949634652"
|
|
width="3%"
|
|
/>
|
|
</a>
|
|
<img src="https://raw.githubusercontent.com/ultralytics/assets/main/social/logo-transparent.png" width="3%"/>
|
|
<a href="https://roboflow.com">
|
|
<img
|
|
src="https://media.roboflow.com/notebooks/template/icons/purple/roboflow-app.png?ik-sdk-version=javascript-1.4.3&updatedAt=1672949746649"
|
|
width="3%"
|
|
/>
|
|
</a>
|
|
<img src="https://raw.githubusercontent.com/ultralytics/assets/main/social/logo-transparent.png" width="3%"/>
|
|
<a href="https://www.linkedin.com/company/roboflow-ai/">
|
|
<img
|
|
src="https://media.roboflow.com/notebooks/template/icons/purple/linkedin.png?ik-sdk-version=javascript-1.4.3&updatedAt=1672949633691"
|
|
width="3%"
|
|
/>
|
|
</a>
|
|
<img src="https://raw.githubusercontent.com/ultralytics/assets/main/social/logo-transparent.png" width="3%"/>
|
|
<a href="https://docs.roboflow.com">
|
|
<img
|
|
src="https://media.roboflow.com/notebooks/template/icons/purple/knowledge.png?ik-sdk-version=javascript-1.4.3&updatedAt=1672949634511"
|
|
width="3%"
|
|
/>
|
|
</a>
|
|
<img src="https://raw.githubusercontent.com/ultralytics/assets/main/social/logo-transparent.png" width="3%"/>
|
|
<a href="https://disuss.roboflow.com">
|
|
<img
|
|
src="https://media.roboflow.com/notebooks/template/icons/purple/forum.png?ik-sdk-version=javascript-1.4.3&updatedAt=1672949633584"
|
|
width="3%"
|
|
/>
|
|
<img src="https://raw.githubusercontent.com/ultralytics/assets/main/social/logo-transparent.png" width="3%"/>
|
|
<a href="https://blog.roboflow.com">
|
|
<img
|
|
src="https://media.roboflow.com/notebooks/template/icons/purple/blog.png?ik-sdk-version=javascript-1.4.3&updatedAt=1672949633605"
|
|
width="3%"
|
|
/>
|
|
</a>
|
|
</a>
|
|
</div>
|
|
|
|
</div>
|