Merge pull request #646 from roboflow/rename-boxmask-annotator

Rename `BoxMaskAnnotator` to `ColorAnnotator`
roboflow · Dec 5, 2023 · 679fee9 · 679fee9
2 parents 2e7ecdd + 4774ace
commit 679fee9
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/docs/annotators.md b/docs/annotators.md
@@ -40,16 +40,16 @@
 
     </div>
 
-=== "BoxMask"
+=== "Color"
 
     ```python
     >>> import supervision as sv
 
     >>> image = ...
     >>> detections = sv.Detections(...)
 
-    >>> box_mask_annotator = sv.BoxMaskAnnotator()
-    >>> annotated_frame = box_mask_annotator.annotate(
+    >>> color_annotator = sv.ColorAnnotator()
+    >>> annotated_frame = color_annotator.annotate(
     ...     scene=image.copy(),
     ...     detections=detections
     ... )
@@ -318,9 +318,9 @@
 
 :::supervision.annotators.core.BoxCornerAnnotator
 
-## BoxMaskAnnotator
+## ColorAnnotator
 
-:::supervision.annotators.core.BoxMaskAnnotator
+:::supervision.annotators.core.ColorAnnotator
 
 ## CircleAnnotator
 

diff --git a/supervision/__init__.py b/supervision/__init__.py
@@ -10,8 +10,8 @@
     BlurAnnotator,
     BoundingBoxAnnotator,
     BoxCornerAnnotator,
-    BoxMaskAnnotator,
     CircleAnnotator,
+    ColorAnnotator,
     DotAnnotator,
     EllipseAnnotator,
     HaloAnnotator,

diff --git a/supervision/annotators/core.py b/supervision/annotators/core.py
@@ -260,7 +260,7 @@ def annotate(
         return scene
 
 
-class BoxMaskAnnotator(BaseAnnotator):
+class ColorAnnotator(BaseAnnotator):
     """
     A class for drawing box masks on an image using provided detections.
     """
@@ -308,8 +308,8 @@ def annotate(
             >>> image = ...
             >>> detections = sv.Detections(...)
 
-            >>> box_mask_annotator = sv.BoxMaskAnnotator()
-            >>> annotated_frame = box_mask_annotator.annotate(
+            >>> color_annotator = sv.ColorAnnotator()
+            >>> annotated_frame = color_annotator.annotate(
             ...     scene=image.copy(),
             ...     detections=detections
             ... )