Merge pull request #828 from roboflow/feature/improved-communication-…

…of-deprecated-features improved communication of deprecated features
roboflow · Jan 31, 2024 · 34af225 · 34af225
2 parents c692d26 + 3d2530f
commit 34af225
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 17 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -54,18 +54,18 @@ ColorPalette(colors=[Color(r=68, g=1, b=84), Color(r=59, g=82, b=139), ...])
 
 - Changed [#756](https://github.com/roboflow/supervision/pull/756): [`sv.Color`](https://supervision.roboflow.com/draw/color/#color)'s and [`sv.ColorPalette`](https://supervision.roboflow.com/draw/color/#colorpalette)'s method of accessing predefined colors, transitioning from a function-based approach (`sv.Color.red()`) to a more intuitive and conventional property-based method (`sv.Color.RED`).
 
-!!! warning
+!!! failure "Deprecated"
 
-    `sv.ColorPalette.default()` is deprecated and will be removed in `supervision-0.21.0`. Use `sv.ColorPalette.DEFAULT` instead.
+    `sv.ColorPalette.default()` is deprecated and will be removed in `supervision-0.22.0`. Use `sv.ColorPalette.DEFAULT` instead.
 
 
 - Changed [#769](https://github.com/roboflow/supervision/pull/769): [`sv.ColorPalette.DEFAULT`](https://supervision.roboflow.com/draw/color/#colorpalette) value, giving users a more extensive set of annotation colors.
 
 - Changed [#677](https://github.com/roboflow/supervision/pull/677): `sv.Detections.from_roboflow` to [`sv.Detections.from_inference`](https://supervision.roboflow.com/detection/core/#supervision.detection.core.Detections.from_inference) streamlining its functionality to be compatible with both the both [inference](https://github.com/roboflow/inference) pip package and the Robloflow [hosted API](https://docs.roboflow.com/deploy/hosted-api).
 
-!!! warning
+!!! failure "Deprecated"
 
-    `Detections.from_roboflow()` is deprecated and will be removed in `supervision-0.21.0`. Use `Detections.from_inference` instead.
+    `Detections.from_roboflow()` is deprecated and will be removed in `supervision-0.22.0`. Use `Detections.from_inference` instead.
 
 
 - Fixed [#735](https://github.com/roboflow/supervision/pull/735): [`sv.LineZone`](https://supervision.roboflow.com/detection/tools/line_zone/#linezone) functionality to accurately update the counter when an object crosses a line from any direction, including from the side. This enhancement enables more precise tracking and analytics, such as calculating individual in/out counts for each lane on the road.
@@ -162,7 +162,7 @@ ColorPalette(colors=[Color(r=68, g=1, b=84), Color(r=59, g=82, b=139), ...])
 
 - Fixed [#430](https://github.com/roboflow/supervision/pull/430):  [`sv.ByteTrack`](https://supervision.roboflow.com/trackers/#supervision.tracker.byte_tracker.core.ByteTrack) to return `np.array([], dtype=int)` when `svDetections` is empty.
 
-!!! warning
+!!! failure "Deprecated"
 
     `sv.Detections.from_yolov8` and `sv.Classifications.from_yolov8` as those are now replaced by [`sv.Detections.from_ultralytics`](https://supervision.roboflow.com/detection/core/#supervision.detection.core.Detections.from_ultralytics) and [`sv.Classifications.from_ultralytics`](https://supervision.roboflow.com/classification/core/#supervision.classification.core.Classifications.from_ultralytics).
 
@@ -231,9 +231,9 @@ ColorPalette(colors=[Color(r=68, g=1, b=84), Color(r=59, g=82, b=139), ...])
 
 - Added [#281](https://github.com/roboflow/supervision/pull/281): [`sv.Classifications.from_ultralytics`](https://supervision.roboflow.com/classification/core/#supervision.classification.core.Classifications.from_ultralytics) to enable seamless integration with [Ultralytics](https://github.com/ultralytics/ultralytics) framework. This will enable you to use supervision with all [models](https://docs.ultralytics.com/models/) that Ultralytics supports.
 
-!!! warning
+!!! failure "Deprecated"
 
-    [sv.Detections.from_yolov8](https://roboflow.github.io/supervision/detection/core/#supervision.detection.core.Detections.from_yolov8) and [sv.Classifications.from_yolov8](https://supervision.roboflow.com/classification/core/#supervision.classification.core.Classifications.from_yolov8) are now deprecated and will be removed with supervision-0.16.0 release.
+    [sv.Detections.from_yolov8](https://roboflow.github.io/supervision/detection/core/#supervision.detection.core.Detections.from_yolov8) and [sv.Classifications.from_yolov8](https://supervision.roboflow.com/classification/core/#supervision.classification.core.Classifications.from_yolov8) are now deprecated and will be removed with `supervision-0.16.0` release.
 
 - Added [#341](https://github.com/roboflow/supervision/pull/341): First supervision usage example script showing how to detect and track objects on video using YOLOv8 + Supervision.
 
@@ -269,7 +269,7 @@ ColorPalette(colors=[Color(r=68, g=1, b=84), Color(r=59, g=82, b=139), ...])
 
 - Added [#222](https://github.com/roboflow/supervision/pull/222): [`sv.Detections.from_ultralytics`](https://roboflow.github.io/supervision/detection/core/#supervision.detection.core.Detections.from_ultralytics) to enable seamless integration with [Ultralytics](https://github.com/ultralytics/ultralytics) framework. This will enable you to use `supervision` with all [models](https://docs.ultralytics.com/models/) that Ultralytics supports.
 
-!!! warning
+!!! failure "Deprecated"
 
     [`sv.Detections.from_yolov8`](https://roboflow.github.io/supervision/detection/core/#supervision.detection.core.Detections.from_yolov8) is now deprecated and will be removed with `supervision-0.15.0` release.
 
@@ -279,7 +279,7 @@ ColorPalette(colors=[Color(r=68, g=1, b=84), Color(r=59, g=82, b=139), ...])
 
 ### 0.12.0 <small>July 24, 2023</small>
 
-!!! warning
+!!! failure "Python 3.7. Support Terminated"
 
     With the `supervision-0.12.0` release, we are terminating official support for Python 3.7.
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -57,7 +57,9 @@ nav:
         - Notebook: utils/notebook.md
         - File: utils/file.md
   - Assets: assets.md
-  - Changelog: changelog.md
+  - Changelog:
+        - Changelog: changelog.md
+        - Deprecated: deprecated.md
 
 theme:
   name: 'material'

diff --git a/supervision/detection/annotate.py b/supervision/detection/annotate.py
@@ -5,8 +5,13 @@
 
 from supervision.detection.core import Detections
 from supervision.draw.color import Color, ColorPalette
+from supervision.utils.internal import deprecated
 
 
+@deprecated(
+    "`BoxAnnotator` is deprecated and will be removed in "
+    "`supervision-0.22.0`. Use `BoundingBoxAnnotator` and `LabelAnnotator` instead"
+)
 class BoxAnnotator:
     """
     A class for drawing bounding boxes on an image using detections provided.

diff --git a/supervision/detection/core.py b/supervision/detection/core.py
@@ -500,10 +500,15 @@ def from_inference(cls, roboflow_result: Union[dict, Any]) -> Detections:
     @classmethod
     @deprecated(
         "`Detections.from_roboflow` is deprecated and will be removed in "
-        "`supervision-0.21.0`. Use `Detections.from_inference` instead."
+        "`supervision-0.22.0`. Use `Detections.from_inference` instead."
     )
     def from_roboflow(cls, roboflow_result: Union[dict, Any]) -> Detections:
         """
+        !!! failure "Deprecated"
+
+            `Detections.from_roboflow` is deprecated and will be removed in
+            `supervision-0.22.0`. Use `Detections.from_inference` instead.
+
         Create a Detections object from the [Roboflow](https://roboflow.com/)
             API inference result or the [Inference](https://inference.roboflow.com/)
             package results.

diff --git a/supervision/draw/color.py b/supervision/draw/color.py
@@ -206,39 +206,39 @@ def ROBOFLOW(cls):
     @classmethod
     @deprecated(
         "`Color.white()` is deprecated and will be removed in "
-        "`supervision-0.20.0`. Use `Color.WHITE` instead."
+        "`supervision-0.22.0`. Use `Color.WHITE` instead."
     )
     def white(cls) -> Color:
         return Color.from_hex(color_hex="#ffffff")
 
     @classmethod
     @deprecated(
         "`Color.black()` is deprecated and will be removed in "
-        "`supervision-0.20.0`. Use `Color.BLACK` instead."
+        "`supervision-0.22.0`. Use `Color.BLACK` instead."
     )
     def black(cls) -> Color:
         return Color.from_hex(color_hex="#000000")
 
     @classmethod
     @deprecated(
         "`Color.red()` is deprecated and will be removed in "
-        "`supervision-0.20.0`. Use `Color.RED` instead."
+        "`supervision-0.22.0`. Use `Color.RED` instead."
     )
     def red(cls) -> Color:
         return Color.from_hex(color_hex="#ff0000")
 
     @classmethod
     @deprecated(
         "`Color.green()` is deprecated and will be removed in "
-        "`supervision-0.20.0`. Use `Color.GREEN` instead."
+        "`supervision-0.22.0`. Use `Color.GREEN` instead."
     )
     def green(cls) -> Color:
         return Color.from_hex(color_hex="#00ff00")
 
     @classmethod
     @deprecated(
         "`Color.blue()` is deprecated and will be removed in "
-        "`supervision-0.20.0`. Use `Color.BLUE` instead."
+        "`supervision-0.22.0`. Use `Color.BLUE` instead."
     )
     def blue(cls) -> Color:
         return Color.from_hex(color_hex="#0000ff")
@@ -297,10 +297,15 @@ def LEGACY(cls) -> ColorPalette:
     @classmethod
     @deprecated(
         "`ColorPalette.default()` is deprecated and will be removed in "
-        "`supervision-0.20.0`. Use `Color.DEFAULT` instead."
+        "`supervision-0.22.0`. Use `Color.DEFAULT` instead."
     )
     def default(cls) -> ColorPalette:
         """
+        !!! failure "Deprecated"
+
+            `ColorPalette.default()` is deprecated and will be removed in
+            `supervision-0.22.0`. Use `Color.DEFAULT` instead.
+
         Returns a default color palette.
 
         Returns: