From c01efeaacaf8b28b847fd58d515bc17099482e21 Mon Sep 17 00:00:00 2001
From: Piotr Skalski
Date: Wed, 17 May 2023 23:08:28 +0200
Subject: [PATCH 1/5] =?UTF-8?q?=F0=9F=93=9A=20Update=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 8f42ed4e..6137f580 100644
--- a/README.md
+++ b/README.md
@@ -66,9 +66,7 @@
## 👋 hello
-A set of easy-to-use utils that will come in handy in any computer vision project. **Supervision is still in
-pre-release stage. 🚧 Keep your eyes open for potential bugs and be aware that at this stage our API is still fluid
-and may change.**
+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 `supervision`! 🤝
## 💻 install
From f03a47a5df0b93018d7d149aee7e85f1b2f73187 Mon Sep 17 00:00:00 2001
From: Piotr Skalski
Date: Thu, 18 May 2023 00:59:01 +0200
Subject: [PATCH 2/5] =?UTF-8?q?=F0=9F=94=A5=20quick=20start=20section?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 146 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 143 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 6137f580..c86252dc 100644
--- a/README.md
+++ b/README.md
@@ -78,7 +78,7 @@ pip install supervision
```
-Install from source
+install from source
```bash
# clone repository and navigate to root directory
@@ -95,9 +95,145 @@ pip install -e ".[dev]"
-## 📖 documentation
+## 🔥 quickstart
-Curious how Supervision can help you solve problems on your project? Visit our [documentation](https://roboflow.github.io/supervision) page!
+### [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
+```
+
+
+👉 more detections utils
+
+- 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
+ ... )
+ ```
+
+
+
+### [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
+```
+
+
+👉 more dataset utils
+
+- 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='...'
+ ... )
+ ```
+
+- Loop over dataset entries
+
+ ```python
+ >>> for 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)
+ ```
+
+- 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='...'
+ ... )
+ ```
+
+- Convert labels between suppoted formats
+
+ ```python
+ >>> sv.DetectionDataset.from_yolo(
+ ... images_directory_path='...',
+ ... annotations_directory_path='...',
+ ... data_yaml_path='...'
+ ... ).as_pascal_voc(
+ ... images_directory_path='...',
+ ... annotations_directory_path='...'
+ ... )
+ ```
+
+
## 🎬 tutorials
@@ -123,6 +259,10 @@ Curious how Supervision can help you solve problems on your project? Visit our [
+## 📚 documentation
+
+Curious how Supervision can help you solve problems on your project? Visit our [documentation](https://roboflow.github.io/supervision) page!
+
## 🏆 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!
From 42d4079b23eca7d9c92745b661d849651fd0c7ab Mon Sep 17 00:00:00 2001
From: Piotr Skalski
Date: Thu, 18 May 2023 01:04:12 +0200
Subject: [PATCH 3/5] =?UTF-8?q?=F0=9F=8E=AC=20video=20clap=20section?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 32 +++++++++++---------------------
1 file changed, 11 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
index c86252dc..fde41e14 100644
--- a/README.md
+++ b/README.md
@@ -66,7 +66,7 @@
## 👋 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 `supervision`! 🤝
+**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
@@ -237,27 +237,17 @@ pip install -e ".[dev]"
## 🎬 tutorials
-🔥 [Subscribe](https://www.youtube.com/@Roboflow) and stay up to date with the latest changes to the Supervision library.
+
+
+Accelerate Image Annotation with SAM and Grounding DINO
+
Created: 20 Apr 2023 | Updated: 20 Apr 2023
+
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...
-
-
-
-
-
-
-
-
-
-
-
+
+
+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...
## 📚 documentation
From 91655f9609e81d2954ed24a14f52b47ea34cfdc8 Mon Sep 17 00:00:00 2001
From: Piotr Skalski
Date: Thu, 18 May 2023 01:07:36 +0200
Subject: [PATCH 4/5] =?UTF-8?q?=F0=9F=96=8C=EF=B8=8F=20final=20README.md?=
=?UTF-8?q?=20updates?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 102 +++++++++++++++++++++++++++++-------------------------
1 file changed, 54 insertions(+), 48 deletions(-)
diff --git a/README.md b/README.md
index fde41e14..4fc21878 100644
--- a/README.md
+++ b/README.md
@@ -10,52 +10,6 @@
-
-
-
-
[](https://badge.fury.io/py/supervision)
[](https://pypistats.org/packages/supervision)
[](https://github.com/roboflow/supervision/blob/main/LICENSE.md)
@@ -241,13 +195,15 @@ pip install -e ".[dev]"
Accelerate Image Annotation with SAM and Grounding DINO
Created: 20 Apr 2023 | Updated: 20 Apr 2023
-
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...
+
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...
+
+
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...
+
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...
## 📚 documentation
@@ -256,3 +212,53 @@ Curious how Supervision can help you solve problems on your project? Visit our [
## 🏆 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!
+
+
+
+
From 5a4cb1b302046173d90fa8d574807b0734c5d8f3 Mon Sep 17 00:00:00 2001
From: Piotr Skalski
Date: Thu, 18 May 2023 01:08:49 +0200
Subject: [PATCH 5/5] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 4fc21878..f14ca93c 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,7 @@ pip install supervision
```
-install from source
+👉 install from source
```bash
# clone repository and navigate to root directory