Skip to content

Rename BoxMaskAnnotator to ColorAnnotator #646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 5, 2023
Merged

Rename BoxMaskAnnotator to ColorAnnotator #646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c46e0f5
rename BoxMaskAnnotator to ColorAnnotator
capjamesg Dec 5, 2023
9d836fa
fix(pre_commit): 🎨 auto format pre-commit hooks
pre-commit-ci[bot] Dec 5, 2023
d53181b
rename variable
capjamesg Dec 5, 2023
9c10308
change heading
capjamesg Dec 5, 2023
7f2b62a
show transparent image
capjamesg Dec 5, 2023
4774ace
Merge branch 'develop' into rename-boxmask-annotator
SkalskiP Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/annotators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
... )
Expand Down Expand Up @@ -318,9 +318,9 @@

:::supervision.annotators.core.BoxCornerAnnotator

## BoxMaskAnnotator
## ColorAnnotator

:::supervision.annotators.core.BoxMaskAnnotator
:::supervision.annotators.core.ColorAnnotator

## CircleAnnotator

Expand Down
2 changes: 1 addition & 1 deletion supervision/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
BlurAnnotator,
BoundingBoxAnnotator,
BoxCornerAnnotator,
BoxMaskAnnotator,
CircleAnnotator,
ColorAnnotator,
DotAnnotator,
EllipseAnnotator,
HaloAnnotator,
Expand Down
6 changes: 3 additions & 3 deletions supervision/annotators/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down Expand Up @@ -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
... )
Expand Down