From 9f730b9fb5d64aea4339afec2d462b6dacbeb013 Mon Sep 17 00:00:00 2001 From: LinasKo Date: Tue, 27 Aug 2024 17:18:44 +0300 Subject: [PATCH] Add "new" tags --- docs/changelog.md | 16 ++++++++-------- docs/datasets/core.md | 1 - docs/deprecated.md | 8 ++++---- docs/detection/tools/inference_slicer.md | 1 + docs/detection/utils.md | 1 - docs/how_to/process_datasets.md | 1 - docs/keypoint/annotators.md | 1 + docs/keypoint/core.md | 1 - docs/utils/file.md | 1 - docs/utils/image.md | 1 + docs/utils/video.md | 1 + 11 files changed, 16 insertions(+), 17 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 39cf7f36..57579f1a 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -15,7 +15,7 @@ results = model.infer(image)[0] detections = sv.Detections.from_inference(results) icon_paths = [] -for class_name in detections.data["class_names"]: +for class_name in detections.data["class_name"]: if class_name == "dog": icon_paths.append(icon_dog) elif class_name == "cat": @@ -31,7 +31,7 @@ annotated_frame = icon_annotator.annotate( ) ``` -- Added [#1385](https://github.com/roboflow/supervision/pull/1385): `BackgroundColorAnnotator`, that draws an overlay on the background images of the detections. +- Added [#1385](https://github.com/roboflow/supervision/pull/1385): [`BackgroundColorAnnotator`](https://supervision.roboflow.com/latest/detection/annotators/#supervision.annotators.core.BackgroundColorAnnotator), that draws an overlay on the background images of the detections. ```python import supervision as sv @@ -50,7 +50,7 @@ annotated_frame = background_overlay_annotator.annotate( ) ``` -- Added [#1386](https://github.com/roboflow/supervision/pull/1386): Support for Transformers v5 functions in `sv.Detections.from_transformers`. This includes the `DetrImageProcessor` methods `post_process_object_detection`, `post_process_panoptic_segmentation`, `post_process_semantic_segmentation`, and `post_process_instance_segmentation`. +- Added [#1386](https://github.com/roboflow/supervision/pull/1386): Support for Transformers v5 functions in [`sv.Detections.from_transformers`](https://supervision.roboflow.com/latest/detection/core/#supervision.detection.core.Detections.from_transformers). This includes the `DetrImageProcessor` methods `post_process_object_detection`, `post_process_panoptic_segmentation`, `post_process_semantic_segmentation`, and `post_process_instance_segmentation`. ```python import torch @@ -76,7 +76,7 @@ detections = sv.Detections.from_transformers( id2label=model.config.id2label) ``` -- Added [#1354](https://github.com/roboflow/supervision/pull/1354): Ultralytics SAM (Segment Anything Model) support in `sv.Detections.from_ultralytics`. SAM2 was released during this update, and is already supported via `sv.Detections.from_sam`. +- Added [#1354](https://github.com/roboflow/supervision/pull/1354): Ultralytics SAM (Segment Anything Model) support in [`sv.Detections.from_ultralytics`](https://supervision.roboflow.com/latest/detection/core/#supervision.detection.core.Detections.from_ultralytics). [SAM2](https://sam2.metademolab.com/) was released during this update, and is already supported via [`sv.Detections.from_sam`](https://supervision.roboflow.com/latest/detection/core/#supervision.detection.core.Detections.from_sam). ```python import supervision as sv @@ -92,15 +92,15 @@ sam_result = mask_generator.generate(IMAGE) detections = sv.Detections.from_sam(sam_result=sam_result) ``` -- Added [#1458](https://github.com/roboflow/supervision/pull/1458): `outline_color` options for `TriangleAnnotator` and `DotAnnotator`. +- Added [#1458](https://github.com/roboflow/supervision/pull/1458): `outline_color` options for [`TriangleAnnotator`](https://supervision.roboflow.com/latest/detection/annotators/#supervision.annotators.core.TriangleAnnotator) and [`DotAnnotator`](https://supervision.roboflow.com/latest/detection/annotators/#supervision.annotators.core.DotAnnotator). -- Added [#1409](https://github.com/roboflow/supervision/pull/1409): `text_color` option for `VertexLabelAnnotator` keypoint annotator. +- Added [#1409](https://github.com/roboflow/supervision/pull/1409): `text_color` option for [`VertexLabelAnnotator`](https://supervision.roboflow.com/latest/keypoint/annotators/#supervision.keypoint.annotators.VertexLabelAnnotator) keypoint annotator. -- Changed [#1434](https://github.com/roboflow/supervision/pull/1434): `InferenceSlicer` now features an `overlap_ratio_wh` parameter, making it easier to compute slice sizes when handling overlapping slices. +- Changed [#1434](https://github.com/roboflow/supervision/pull/1434): [`InferenceSlicer`](https://supervision.roboflow.com/latest/detection/tools/inference_slicer/) now features an `overlap_ratio_wh` parameter, making it easier to compute slice sizes when handling overlapping slices. - Fix [#1448](https://github.com/roboflow/supervision/pull/1448): Various annotator type issues have been resolved, supporting expanded error handling. -- Fix [#1348](https://github.com/roboflow/supervision/pull/1348): Introduced a new method for seeking to a specific video frame, addressing cases where traditional seek methods were failing. It can be enabled with `iterative_seek=True`. +- Fix [#1348](https://github.com/roboflow/supervision/pull/1348): Introduced a new method for [seeking to a specific video frame](https://supervision.roboflow.com/latest/utils/video/#supervision.utils.video.get_video_frames_generator), addressing cases where traditional seek methods were failing. It can be enabled with `iterative_seek=True`. ```python import supervision as sv diff --git a/docs/datasets/core.md b/docs/datasets/core.md index 03d0c196..73931515 100644 --- a/docs/datasets/core.md +++ b/docs/datasets/core.md @@ -1,6 +1,5 @@ --- comments: true -status: new --- # Datasets diff --git a/docs/deprecated.md b/docs/deprecated.md index 0d2f456b..9508f6bf 100644 --- a/docs/deprecated.md +++ b/docs/deprecated.md @@ -9,12 +9,12 @@ These features are phased out due to better alternatives or potential issues in - The `frame_resolution_wh ` parameter in [`sv.PolygonZone`](detection/tools/polygon_zone.md/#supervision.detection.tools.polygon_zone.PolygonZone) will be removed in `supervision-0.24.0`. -- Constructing `DetectionDataset` and `ClassificationDataset` with parameter `images` as `Dict[str, np.ndarray]` will be removed in `supervision-0.26.0`. Please pass a list of paths `List[str]` instead. +- Constructing [`DetectionDataset`](https://supervision.roboflow.com/latest/datasets/core/#supervision.dataset.core.DetectionDataset) and [`ClassificationDataset`](https://supervision.roboflow.com/latest/datasets/core/#supervision.dataset.core.ClassificationDataset) with parameter `images` as `Dict[str, np.ndarray]` will be removed in `supervision-0.26.0`. Please pass a list of paths `List[str]` instead. - The `DetectionDataset.images` property will be removed in `supervision-0.26.0`. Please loop over images with `for path, image, annotation in dataset:`, as that does not require loading all images into memory. -- `BoundingBoxAnnotator` has been renamed to `BoxAnnotator` after the old implementation of `BoxAnnotator` has been removed. `BoundingBoxAnnotator` will be removed in `supervision-0.26.0`. +- `BoundingBoxAnnotator` has been renamed to `BoxAnnotator` after the old implementation of [`BoxAnnotator`](https://supervision.roboflow.com/latest/detection/annotators/#supervision.annotators.core.BoxAnnotator) has been removed. `BoundingBoxAnnotator` will be removed in `supervision-0.26.0`. -- `overlap_filter_strategy` in `InferenceSlicer.__init__` is deprecated and will be removed in `supervision-0.27.0`. Use `overlap_strategy` instead. -- `overlap_ratio_wh` in `InferenceSlicer.__init__` is deprecated and will be removed in `supervision-0.27.0`. Use `overlap_wh` instead. +- `overlap_filter_strategy` in [`InferenceSlicer.__init__`](https://supervision.roboflow.com/latest/detection/tools/inference_slicer/) is deprecated and will be removed in `supervision-0.27.0`. Use `overlap_strategy` instead. +- `overlap_ratio_wh` in [`InferenceSlicer.__init__`](https://supervision.roboflow.com/latest/detection/tools/inference_slicer/) is deprecated and will be removed in `supervision-0.27.0`. Use `overlap_wh` instead. # Removed diff --git a/docs/detection/tools/inference_slicer.md b/docs/detection/tools/inference_slicer.md index 5d5d08bc..7a5d3e57 100644 --- a/docs/detection/tools/inference_slicer.md +++ b/docs/detection/tools/inference_slicer.md @@ -1,5 +1,6 @@ --- comments: true +status: new --- # InferenceSlicer diff --git a/docs/detection/utils.md b/docs/detection/utils.md index bfb62187..d2fd2a0c 100644 --- a/docs/detection/utils.md +++ b/docs/detection/utils.md @@ -1,6 +1,5 @@ --- comments: true -status: new --- # Detection Utils diff --git a/docs/how_to/process_datasets.md b/docs/how_to/process_datasets.md index 36806b2d..36c122df 100644 --- a/docs/how_to/process_datasets.md +++ b/docs/how_to/process_datasets.md @@ -1,6 +1,5 @@ --- comments: true -status: new --- With Supervision, you can load and manipulate classification, object detection, and diff --git a/docs/keypoint/annotators.md b/docs/keypoint/annotators.md index 32f30626..30a970ec 100644 --- a/docs/keypoint/annotators.md +++ b/docs/keypoint/annotators.md @@ -1,5 +1,6 @@ --- comments: true +status: new --- # Annotators diff --git a/docs/keypoint/core.md b/docs/keypoint/core.md index 7354baba..6f42c254 100644 --- a/docs/keypoint/core.md +++ b/docs/keypoint/core.md @@ -1,6 +1,5 @@ --- comments: true -status: new --- # Keypoint Detection diff --git a/docs/utils/file.md b/docs/utils/file.md index f99cf8dc..a2a08185 100644 --- a/docs/utils/file.md +++ b/docs/utils/file.md @@ -1,6 +1,5 @@ --- comments: true -status: new --- # File Utils diff --git a/docs/utils/image.md b/docs/utils/image.md index 8e39136a..93cc5a45 100644 --- a/docs/utils/image.md +++ b/docs/utils/image.md @@ -1,5 +1,6 @@ --- comments: true +status: new --- # Image Utils diff --git a/docs/utils/video.md b/docs/utils/video.md index f9a5821d..dfae543d 100644 --- a/docs/utils/video.md +++ b/docs/utils/video.md @@ -1,5 +1,6 @@ --- comments: true +status: new --- # Video Utils