MORPH
SIGN IN SIGN UP
roboflow / supervision UNCLAIMED

We write your reusable computer vision tools. 💜

36789 0 0 Python
Normal View History Raw
ready for review
2024-01-17 12:11:31 +01:00
---
comments: true
---
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
# Annotators
Update annotators.md included description of what annotators are; clarified how to use the visualization widget
2024-10-03 11:45:41 -07:00
Annotators accept detections and apply box or mask visualizations to the detections. Annotators have many available styles.
Deprecate BoundingBoxAnnotator, rename to BoxAnnotator
2024-07-12 18:18:50 +03:00
=== "Box"
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
```python
docs: 📝 supervision/annotators/core.py docs/annotators.md >>>/... removed Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-24 12:50:23 +03:00
import supervision as sv
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
docs: 📝 supervision/annotators/core.py docs/annotators.md >>>/... removed Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-24 12:50:23 +03:00
image = ...
detections = sv.Detections(...)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
Deprecate BoundingBoxAnnotator, rename to BoxAnnotator
2024-07-12 18:18:50 +03:00
box_annotator = sv.BoxAnnotator()
annotated_frame = box_annotator.annotate(
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
docs: 📝 supervision/annotators/core.py docs/annotators.md >>>/... removed Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-24 12:50:23 +03:00
)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
```
<div class="result" markdown>
Update example images and modify code parameters
2023-10-09 16:15:35 +02:00
![bounding-box-annotator-example](https://media.roboflow.com/supervision-annotator-examples/bounding-box-annotator-example-purple.png){ align=center width="800" }
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
</div>
updates before `supervision-0.26.0` release
2025-07-16 01:04:51 +02:00
=== "RoundBox"
docs: 📝 RoundBoundingBox documentations and small change on code section Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-05 22:59:29 +03:00
updates before `supervision-0.26.0` release
2025-07-16 01:04:51 +02:00
```python
import supervision as sv
docs: 📝 RoundBoundingBox documentations and small change on code section Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-05 22:59:29 +03:00
updates before `supervision-0.26.0` release
2025-07-16 01:04:51 +02:00
image = ...
detections = sv.Detections(...)
docs: 📝 RoundBoundingBox documentations and small change on code section Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-05 22:59:29 +03:00
updates before `supervision-0.26.0` release
2025-07-16 01:04:51 +02:00
round_box_annotator = sv.RoundBoxAnnotator()
annotated_frame = round_box_annotator.annotate(
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
updates before `supervision-0.26.0` release
2025-07-16 01:04:51 +02:00
)
```
docs: 📝 RoundBoundingBox documentations and small change on code section Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-05 22:59:29 +03:00
updates before `supervision-0.26.0` release
2025-07-16 01:04:51 +02:00
<div class="result" markdown>
docs: 📝 RoundBoundingBox documentations and small change on code section Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-05 22:59:29 +03:00
updates before `supervision-0.26.0` release
2025-07-16 01:04:51 +02:00
![round-box-annotator-example](https://media.roboflow.com/supervision-annotator-examples/round-box-annotator-example-purple.png){ align=center width="800" }
docs: 📝 RoundBoundingBox documentations and small change on code section Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-05 22:59:29 +03:00
updates before `supervision-0.26.0` release
2025-07-16 01:04:51 +02:00
</div>
docs: 📝 RoundBoundingBox documentations and small change on code section Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-05 22:59:29 +03:00
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
=== "BoxCorner"
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
docs: example image = ... reverted and added annotators.md
2024-01-21 12:06:10 +05:30
image = ...
detections = sv.Detections(...)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
corner_annotator = sv.BoxCornerAnnotator()
annotated_frame = corner_annotator.annotate(
docs: 📝 supervision/annotators/core.py docs/annotators.md >>>/... removed Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-24 12:50:23 +03:00
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
docs: 📝 supervision/annotators/core.py docs/annotators.md >>>/... removed Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-24 12:50:23 +03:00
)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
```
<div class="result" markdown>
Update example images and modify code parameters
2023-10-09 16:15:35 +02:00
![box-corner-annotator-example](https://media.roboflow.com/supervision-annotator-examples/box-corner-annotator-example-purple.png){ align=center width="800" }
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
</div>
change heading
2023-12-05 10:42:05 +00:00
=== "Color"
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
docs: example image = ... reverted and added annotators.md
2024-01-21 12:06:10 +05:30
image = ...
detections = sv.Detections(...)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
color_annotator = sv.ColorAnnotator()
annotated_frame = color_annotator.annotate(
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
```
<div class="result" markdown>
Update example images and modify code parameters
2023-10-09 16:15:35 +02:00
![box-mask-annotator-example](https://media.roboflow.com/supervision-annotator-examples/box-mask-annotator-example-purple.png){ align=center width="800" }
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
</div>
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
=== "Circle"
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
docs: example image = ... reverted and added annotators.md
2024-01-21 12:06:10 +05:30
image = ...
detections = sv.Detections(...)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
circle_annotator = sv.CircleAnnotator()
annotated_frame = circle_annotator.annotate(
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
```
<div class="result" markdown>
Update example images and modify code parameters
2023-10-09 16:15:35 +02:00
![circle-annotator-example](https://media.roboflow.com/supervision-annotator-examples/circle-annotator-example-purple.png){ align=center width="800" }
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
</div>
Expand and update Color, ColorPalette, and DotAnnotator classes Added detailed comments and examples to the Color and ColorPalette classes in supervision/draw/color.py, in addition to the DotAnnotator class in supervision/annotators/core.py. The changes clarify the usage and function of these classes. Also appended to the documentation by creating a new section for Color in docs/draw/color.md and including Color and DotAnnotator in docs/annotators.md. Incorporated the new documentation into the navigation structure in mkdocs.yml for user accessibility. The improvements enhance overall code-readability and understandability.
2023-10-18 18:53:39 +02:00
=== "Dot"
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
Expand and update Color, ColorPalette, and DotAnnotator classes Added detailed comments and examples to the Color and ColorPalette classes in supervision/draw/color.py, in addition to the DotAnnotator class in supervision/annotators/core.py. The changes clarify the usage and function of these classes. Also appended to the documentation by creating a new section for Color in docs/draw/color.md and including Color and DotAnnotator in docs/annotators.md. Incorporated the new documentation into the navigation structure in mkdocs.yml for user accessibility. The improvements enhance overall code-readability and understandability.
2023-10-18 18:53:39 +02:00
docs: example image = ... reverted and added annotators.md
2024-01-21 12:06:10 +05:30
image = ...
detections = sv.Detections(...)
Expand and update Color, ColorPalette, and DotAnnotator classes Added detailed comments and examples to the Color and ColorPalette classes in supervision/draw/color.py, in addition to the DotAnnotator class in supervision/annotators/core.py. The changes clarify the usage and function of these classes. Also appended to the documentation by creating a new section for Color in docs/draw/color.md and including Color and DotAnnotator in docs/annotators.md. Incorporated the new documentation into the navigation structure in mkdocs.yml for user accessibility. The improvements enhance overall code-readability and understandability.
2023-10-18 18:53:39 +02:00
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
dot_annotator = sv.DotAnnotator()
annotated_frame = dot_annotator.annotate(
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
)
Expand and update Color, ColorPalette, and DotAnnotator classes Added detailed comments and examples to the Color and ColorPalette classes in supervision/draw/color.py, in addition to the DotAnnotator class in supervision/annotators/core.py. The changes clarify the usage and function of these classes. Also appended to the documentation by creating a new section for Color in docs/draw/color.md and including Color and DotAnnotator in docs/annotators.md. Incorporated the new documentation into the navigation structure in mkdocs.yml for user accessibility. The improvements enhance overall code-readability and understandability.
2023-10-18 18:53:39 +02:00
```
<div class="result" markdown>
docs: 📝 PercentageBar Annotator docs and usage added. Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-22 21:52:56 +03:00
![dot-annotator-example](https://media.roboflow.com/supervision-annotator-examples/dot-annotator-example-purple.png){ align=center width="800" }
Expand and update Color, ColorPalette, and DotAnnotator classes Added detailed comments and examples to the Color and ColorPalette classes in supervision/draw/color.py, in addition to the DotAnnotator class in supervision/annotators/core.py. The changes clarify the usage and function of these classes. Also appended to the documentation by creating a new section for Color in docs/draw/color.md and including Color and DotAnnotator in docs/annotators.md. Incorporated the new documentation into the navigation structure in mkdocs.yml for user accessibility. The improvements enhance overall code-readability and understandability.
2023-10-18 18:53:39 +02:00
</div>
Add TriangleAnnotator example to documentation
2023-12-06 13:59:05 +01:00
=== "Triangle"
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
Add TriangleAnnotator example to documentation
2023-12-06 13:59:05 +01:00
docs: example image = ... reverted and added annotators.md
2024-01-21 12:06:10 +05:30
image = ...
detections = sv.Detections(...)
Add TriangleAnnotator example to documentation
2023-12-06 13:59:05 +01:00
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
triangle_annotator = sv.TriangleAnnotator()
annotated_frame = triangle_annotator.annotate(
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
)
Add TriangleAnnotator example to documentation
2023-12-06 13:59:05 +01:00
```
<div class="result" markdown>
![triangle-annotator-example](https://media.roboflow.com/supervision-annotator-examples/triangle-annotator-example.png){ align=center width="800" }
</div>
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
=== "Ellipse"
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
docs: example image = ... reverted and added annotators.md
2024-01-21 12:06:10 +05:30
image = ...
detections = sv.Detections(...)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
ellipse_annotator = sv.EllipseAnnotator()
annotated_frame = ellipse_annotator.annotate(
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
```
<div class="result" markdown>
Update example images and modify code parameters
2023-10-09 16:15:35 +02:00
![ellipse-annotator-example](https://media.roboflow.com/supervision-annotator-examples/ellipse-annotator-example-purple.png){ align=center width="800" }
</div>
=== "Halo"
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
Update example images and modify code parameters
2023-10-09 16:15:35 +02:00
docs: example image = ... reverted and added annotators.md
2024-01-21 12:06:10 +05:30
image = ...
detections = sv.Detections(...)
Update example images and modify code parameters
2023-10-09 16:15:35 +02:00
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
halo_annotator = sv.HaloAnnotator()
annotated_frame = halo_annotator.annotate(
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
)
Update example images and modify code parameters
2023-10-09 16:15:35 +02:00
```
<div class="result" markdown>
docs: 📝 PercentageBar Annotator docs and usage added. Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-22 21:52:56 +03:00
![halo-annotator-example](https://media.roboflow.com/supervision-annotator-examples/halo-annotator-example-purple.png){ align=center width="800" }
</div>
=== "PercentageBar"
```python
docs: 📝 supervision/annotators/core.py PercentageBarAnnotator >>>/... removed Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-24 15:40:08 +03:00
import supervision as sv
docs: 📝 PercentageBar Annotator docs and usage added. Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-22 21:52:56 +03:00
docs: 📝 supervision/annotators/core.py PercentageBarAnnotator >>>/... removed Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-24 15:40:08 +03:00
image = ...
detections = sv.Detections(...)
docs: 📝 PercentageBar Annotator docs and usage added. Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-22 21:52:56 +03:00
docs: 📝 supervision/annotators/core.py PercentageBarAnnotator >>>/... removed Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-24 15:40:08 +03:00
percentage_bar_annotator = sv.PercentageBarAnnotator()
annotated_frame = percentage_bar_annotator.annotate(
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
docs: 📝 supervision/annotators/core.py PercentageBarAnnotator >>>/... removed Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-24 15:40:08 +03:00
)
docs: 📝 PercentageBar Annotator docs and usage added. Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-22 21:52:56 +03:00
```
<div class="result" markdown>
![percentage-bar-annotator-example](https://media.roboflow.com/supervision-annotator-examples/percentage-bar-annotator-example-purple.png){ align=center width="800" }
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
</div>
=== "Mask"
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
docs: example image = ... reverted and added annotators.md
2024-01-21 12:06:10 +05:30
image = ...
detections = sv.Detections(...)
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
mask_annotator = sv.MaskAnnotator()
annotated_frame = mask_annotator.annotate(
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
)
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
```
<div class="result" markdown>
Chore CI by adding checks for links and references (#2113) * Chore CI by adding checks for links and references * Potential fix for code scanning alert no. 6: Workflow does not contain permissions * Fix markdown image formatting in metrics documentation * Update all `docs` links to use absolute URLs and fix broken references in documentation and workflows. * Fix broken `albumentations` links in dataset processing documentation * lycheeVersion: v0.22.0 * Refactor CI link check workflow to use lychee config file for cleaner argument management * add TODOs for future file type support * Fix header formatting for example plots across metric files --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-03 01:01:19 +09:00
![mask-annotator-example](https://media.roboflow.com/supervision-annotator-examples/mask-annotator-example-purple.png){ align=center width="800" }
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
</div>
Added a visual and code example for `PolygonAnnotator` in `supervision/annotators/core.py` and `docs/annotators.md`.
2023-11-15 17:49:17 +01:00
=== "Polygon"
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
Added a visual and code example for `PolygonAnnotator` in `supervision/annotators/core.py` and `docs/annotators.md`.
2023-11-15 17:49:17 +01:00
docs: example image = ... reverted and added annotators.md
2024-01-21 12:06:10 +05:30
image = ...
detections = sv.Detections(...)
Added a visual and code example for `PolygonAnnotator` in `supervision/annotators/core.py` and `docs/annotators.md`.
2023-11-15 17:49:17 +01:00
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
polygon_annotator = sv.PolygonAnnotator()
annotated_frame = polygon_annotator.annotate(
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
)
Added a visual and code example for `PolygonAnnotator` in `supervision/annotators/core.py` and `docs/annotators.md`.
2023-11-15 17:49:17 +01:00
```
<div class="result" markdown>
Chore CI by adding checks for links and references (#2113) * Chore CI by adding checks for links and references * Potential fix for code scanning alert no. 6: Workflow does not contain permissions * Fix markdown image formatting in metrics documentation * Update all `docs` links to use absolute URLs and fix broken references in documentation and workflows. * Fix broken `albumentations` links in dataset processing documentation * lycheeVersion: v0.22.0 * Refactor CI link check workflow to use lychee config file for cleaner argument management * add TODOs for future file type support * Fix header formatting for example plots across metric files --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-03 01:01:19 +09:00
![polygon-annotator-example](https://media.roboflow.com/supervision-annotator-examples/polygon-annotator-example-purple.png){ align=center width="800" }
Added a visual and code example for `PolygonAnnotator` in `supervision/annotators/core.py` and `docs/annotators.md`.
2023-11-15 17:49:17 +01:00
</div>
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
=== "Label"
```python
fix `LabelAnnotator` code snippets
2024-03-25 15:01:59 +01:00
import supervision as sv
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
docs: example image = ... reverted and added annotators.md
2024-01-21 12:06:10 +05:30
image = ...
detections = sv.Detections(...)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
fix `LabelAnnotator` code snippets
2024-03-25 15:01:59 +01:00
labels = [
f"{class_name} {confidence:.2f}"
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
for class_name, confidence in zip(
detections["class_name"],
detections.confidence,
)
fix `LabelAnnotator` code snippets
2024-03-25 15:01:59 +01:00
]
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
label_annotator = sv.LabelAnnotator(text_position=sv.Position.CENTER)
annotated_frame = label_annotator.annotate(
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
scene=image.copy(), detections=detections, labels=labels
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
```
<div class="result" markdown>
Chore CI by adding checks for links and references (#2113) * Chore CI by adding checks for links and references * Potential fix for code scanning alert no. 6: Workflow does not contain permissions * Fix markdown image formatting in metrics documentation * Update all `docs` links to use absolute URLs and fix broken references in documentation and workflows. * Fix broken `albumentations` links in dataset processing documentation * lycheeVersion: v0.22.0 * Refactor CI link check workflow to use lychee config file for cleaner argument management * add TODOs for future file type support * Fix header formatting for example plots across metric files --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-03 01:01:19 +09:00
![label-annotator-example](https://media.roboflow.com/supervision-annotator-examples/label-annotator-example-purple.png){ align=center width="800" }
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
</div>
docs: 📝 RichLabelAnnotator documentation added into docs and minor var fixes Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-05-15 18:35:36 +03:00
=== "RichLabel"
```python
import supervision as sv
image = ...
detections = sv.Detections(...)
labels = [
f"{class_name} {confidence:.2f}"
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
for class_name, confidence in zip(
detections["class_name"],
detections.confidence,
)
docs: 📝 RichLabelAnnotator documentation added into docs and minor var fixes Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-05-15 18:35:36 +03:00
]
rich_label_annotator = sv.RichLabelAnnotator(
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
font_path="TTF_FONT_PATH",
text_position=sv.Position.CENTER,
docs: 📝 RichLabelAnnotator documentation added into docs and minor var fixes Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-05-15 18:35:36 +03:00
)
Fix typo in RichLabelAnnotator docs
2024-07-24 17:37:00 +05:30
annotated_frame = rich_label_annotator.annotate(
docs: 📝 RichLabelAnnotator documentation added into docs and minor var fixes Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-05-15 18:35:36 +03:00
scene=image.copy(),
detections=detections,
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
labels=labels,
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
)
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
```
<div class="result" markdown>
Chore CI by adding checks for links and references (#2113) * Chore CI by adding checks for links and references * Potential fix for code scanning alert no. 6: Workflow does not contain permissions * Fix markdown image formatting in metrics documentation * Update all `docs` links to use absolute URLs and fix broken references in documentation and workflows. * Fix broken `albumentations` links in dataset processing documentation * lycheeVersion: v0.22.0 * Refactor CI link check workflow to use lychee config file for cleaner argument management * add TODOs for future file type support * Fix header formatting for example plots across metric files --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-03 01:01:19 +09:00
![label-annotator-example](https://media.roboflow.com/supervision-annotator-examples/label-annotator-example-purple.png){ align=center width="800" }
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
</div>
Icon annotator example
2024-08-26 23:53:54 +03:00
=== "Icon"
```python
import supervision as sv
image = ...
detections = sv.Detections(...)
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
icon_paths = ["<ICON_PATH>" for _ in detections]
Icon annotator example
2024-08-26 23:53:54 +03:00
icon_annotator = sv.IconAnnotator()
annotated_frame = icon_annotator.annotate(
scene=image.copy(),
detections=detections,
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
icon_path=icon_paths,
Icon annotator example
2024-08-26 23:53:54 +03:00
)
```
<div class="result" markdown>
Chore CI by adding checks for links and references (#2113) * Chore CI by adding checks for links and references * Potential fix for code scanning alert no. 6: Workflow does not contain permissions * Fix markdown image formatting in metrics documentation * Update all `docs` links to use absolute URLs and fix broken references in documentation and workflows. * Fix broken `albumentations` links in dataset processing documentation * lycheeVersion: v0.22.0 * Refactor CI link check workflow to use lychee config file for cleaner argument management * add TODOs for future file type support * Fix header formatting for example plots across metric files --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-03 01:01:19 +09:00
![icon-annotator-example](https://media.roboflow.com/supervision-annotator-examples/icon-annotator-example.png){ align=center width="800" }
Icon annotator example
2024-08-26 23:53:54 +03:00
</div>
Add ComparisonAnnotator docs, remove Crop & RoundBox annotator from preview * Up to 20 tabs can be made at once. This is likely a bug relating to the underlying mkdocs plugin, but a quick check for hardcoded values yielded nothing.
2024-12-11 16:58:36 +02:00
<!-- === "Crop"
add CropAnnotator docs
2024-03-14 14:43:19 +01:00
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
```python
import supervision as sv
add CropAnnotator docs
2024-03-14 14:43:19 +01:00
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
image = ...
detections = sv.Detections(...)
add CropAnnotator docs
2024-03-14 14:43:19 +01:00
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
crop_annotator = sv.CropAnnotator()
annotated_frame = crop_annotator.annotate(
scene=image.copy(),
detections=detections,
)
```
Add CropAnnotator image example
2024-12-11 18:09:31 +02:00
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
<div class="result" markdown>
![crop-annotator-example](https://media.roboflow.com/supervision-annotator-examples/crop-annotator-example.png){ align=center width="800" }
</div>
Add CropAnnotator image example
2024-12-11 18:09:31 +02:00
Add ComparisonAnnotator docs, remove Crop & RoundBox annotator from preview * Up to 20 tabs can be made at once. This is likely a bug relating to the underlying mkdocs plugin, but a quick check for hardcoded values yielded nothing.
2024-12-11 16:58:36 +02:00
-->
add CropAnnotator docs
2024-03-14 14:43:19 +01:00
Refactor BlurAnnotator class and update documentation
2023-10-04 23:50:47 +02:00
=== "Blur"
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
Refactor BlurAnnotator class and update documentation
2023-10-04 23:50:47 +02:00
docs: example image = ... reverted and added annotators.md
2024-01-21 12:06:10 +05:30
image = ...
detections = sv.Detections(...)
Refactor BlurAnnotator class and update documentation
2023-10-04 23:50:47 +02:00
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
blur_annotator = sv.BlurAnnotator()
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
annotated_frame = (blur_annotator.annotate(scene=image.copy(), detections=detections),)
Refactor BlurAnnotator class and update documentation
2023-10-04 23:50:47 +02:00
```
<div class="result" markdown>
Chore CI by adding checks for links and references (#2113) * Chore CI by adding checks for links and references * Potential fix for code scanning alert no. 6: Workflow does not contain permissions * Fix markdown image formatting in metrics documentation * Update all `docs` links to use absolute URLs and fix broken references in documentation and workflows. * Fix broken `albumentations` links in dataset processing documentation * lycheeVersion: v0.22.0 * Refactor CI link check workflow to use lychee config file for cleaner argument management * add TODOs for future file type support * Fix header formatting for example plots across metric files --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-03 01:01:19 +09:00
![blur-annotator-example](https://media.roboflow.com/supervision-annotator-examples/blur-annotator-example-purple.png){ align=center width="800" }
Refactor BlurAnnotator class and update documentation
2023-10-04 23:50:47 +02:00
</div>
Refactor PixelateAnnotator and update docs
2023-12-05 12:03:59 +01:00
=== "Pixelate"
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
Refactor PixelateAnnotator and update docs
2023-12-05 12:03:59 +01:00
docs: example image = ... reverted and added annotators.md
2024-01-21 12:06:10 +05:30
image = ...
detections = sv.Detections(...)
Refactor PixelateAnnotator and update docs
2023-12-05 12:03:59 +01:00
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
pixelate_annotator = sv.PixelateAnnotator()
annotated_frame = pixelate_annotator.annotate(
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
)
Refactor PixelateAnnotator and update docs
2023-12-05 12:03:59 +01:00
```
<div class="result" markdown>
Chore CI by adding checks for links and references (#2113) * Chore CI by adding checks for links and references * Potential fix for code scanning alert no. 6: Workflow does not contain permissions * Fix markdown image formatting in metrics documentation * Update all `docs` links to use absolute URLs and fix broken references in documentation and workflows. * Fix broken `albumentations` links in dataset processing documentation * lycheeVersion: v0.22.0 * Refactor CI link check workflow to use lychee config file for cleaner argument management * add TODOs for future file type support * Fix header formatting for example plots across metric files --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-03 01:01:19 +09:00
![pixelate-annotator-example](https://media.roboflow.com/supervision-annotator-examples/pixelate-annotator-example-10.png){ align=center width="800" }
Refactor PixelateAnnotator and update docs
2023-12-05 12:03:59 +01:00
</div>
Add TraceAnnotator description to the documentation The documentation has been updated to include the `TraceAnnotator` class.
2023-10-04 15:35:07 +02:00
=== "Trace"
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
from ultralytics import YOLO
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
model = YOLO("yolov8x.pt")
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
trace_annotator = sv.TraceAnnotator()
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
video_info = sv.VideoInfo.from_video_path(video_path="...")
frames_generator = sv.get_video_frames_generator(source_path="...")
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
tracker = sv.ByteTrack()
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
with sv.VideoSink(target_path="...", video_info=video_info) as sink:
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
for frame in frames_generator:
result = model(frame)[0]
detections = sv.Detections.from_ultralytics(result)
detections = tracker.update_with_detections(detections)
annotated_frame = trace_annotator.annotate(
scene=frame.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
)
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
sink.write_frame(frame=annotated_frame)
Update example code blocks in `core.py` and `annotators.md` Code examples in `supervision/annotators/core.py` and `docs/annotators.md` have been updated for clarity and consistency. The changes include renaming variables more appropriately and elaborating on the video processing steps which now includes tracking and annotating frames using a YOLO model. This revision aims to make examples more understandable and consistent for users following the documentation.
2023-10-18 21:25:44 +02:00
```
<div class="result" markdown>
Chore CI by adding checks for links and references (#2113) * Chore CI by adding checks for links and references * Potential fix for code scanning alert no. 6: Workflow does not contain permissions * Fix markdown image formatting in metrics documentation * Update all `docs` links to use absolute URLs and fix broken references in documentation and workflows. * Fix broken `albumentations` links in dataset processing documentation * lycheeVersion: v0.22.0 * Refactor CI link check workflow to use lychee config file for cleaner argument management * add TODOs for future file type support * Fix header formatting for example plots across metric files --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-03 01:01:19 +09:00
![trace-annotator-example](https://media.roboflow.com/supervision-annotator-examples/trace-annotator-example-purple.png){ align=center width="800" }
Update example code blocks in `core.py` and `annotators.md` Code examples in `supervision/annotators/core.py` and `docs/annotators.md` have been updated for clarity and consistency. The changes include renaming variables more appropriately and elaborating on the video processing steps which now includes tracking and annotating frames using a YOLO model. This revision aims to make examples more understandable and consistent for users following the documentation.
2023-10-18 21:25:44 +02:00
</div>
=== "HeatMap"
```python
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
import supervision as sv
from ultralytics import YOLO
Update example code blocks in `core.py` and `annotators.md` Code examples in `supervision/annotators/core.py` and `docs/annotators.md` have been updated for clarity and consistency. The changes include renaming variables more appropriately and elaborating on the video processing steps which now includes tracking and annotating frames using a YOLO model. This revision aims to make examples more understandable and consistent for users following the documentation.
2023-10-18 21:25:44 +02:00
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
model = YOLO("yolov8x.pt")
Update example code blocks in `core.py` and `annotators.md` Code examples in `supervision/annotators/core.py` and `docs/annotators.md` have been updated for clarity and consistency. The changes include renaming variables more appropriately and elaborating on the video processing steps which now includes tracking and annotating frames using a YOLO model. This revision aims to make examples more understandable and consistent for users following the documentation.
2023-10-18 21:25:44 +02:00
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
heat_map_annotator = sv.HeatMapAnnotator()
Update example code blocks in `core.py` and `annotators.md` Code examples in `supervision/annotators/core.py` and `docs/annotators.md` have been updated for clarity and consistency. The changes include renaming variables more appropriately and elaborating on the video processing steps which now includes tracking and annotating frames using a YOLO model. This revision aims to make examples more understandable and consistent for users following the documentation.
2023-10-18 21:25:44 +02:00
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
video_info = sv.VideoInfo.from_video_path(video_path="...")
frames_generator = sv.get_video_frames_generator(source_path="...")
Update example code blocks in `core.py` and `annotators.md` Code examples in `supervision/annotators/core.py` and `docs/annotators.md` have been updated for clarity and consistency. The changes include renaming variables more appropriately and elaborating on the video processing steps which now includes tracking and annotating frames using a YOLO model. This revision aims to make examples more understandable and consistent for users following the documentation.
2023-10-18 21:25:44 +02:00
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
with sv.VideoSink(target_path="...", video_info=video_info) as sink:
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
for frame in frames_generator:
result = model(frame)[0]
detections = sv.Detections.from_ultralytics(result)
annotated_frame = heat_map_annotator.annotate(
scene=frame.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
)
docs: '>>>' and '...' are removed and indentation improvements
2024-01-20 14:19:06 +05:30
sink.write_frame(frame=annotated_frame)
Add TraceAnnotator description to the documentation The documentation has been updated to include the `TraceAnnotator` class.
2023-10-04 15:35:07 +02:00
```
<div class="result" markdown>
Chore CI by adding checks for links and references (#2113) * Chore CI by adding checks for links and references * Potential fix for code scanning alert no. 6: Workflow does not contain permissions * Fix markdown image formatting in metrics documentation * Update all `docs` links to use absolute URLs and fix broken references in documentation and workflows. * Fix broken `albumentations` links in dataset processing documentation * lycheeVersion: v0.22.0 * Refactor CI link check workflow to use lychee config file for cleaner argument management * add TODOs for future file type support * Fix header formatting for example plots across metric files --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-03 01:01:19 +09:00
![heat-map-annotator-example](https://media.roboflow.com/supervision-annotator-examples/heat-map-annotator-example-purple.png){ align=center width="800" }
Add TraceAnnotator description to the documentation The documentation has been updated to include the `TraceAnnotator` class.
2023-10-04 15:35:07 +02:00
</div>
add BackgroundColorAnnotator docs
2024-08-07 09:21:16 +01:00
=== "Background Color"
```python
import supervision as sv
image = ...
detections = sv.Detections(...)
Rename to BackgoundOverlayAnnotator, fix return after copy
2024-08-07 16:39:22 +03:00
background_overlay_annotator = sv.BackgroundOverlayAnnotator()
annotated_frame = background_overlay_annotator.annotate(
add BackgroundColorAnnotator docs
2024-08-07 09:21:16 +01:00
scene=image.copy(),
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections=detections,
add BackgroundColorAnnotator docs
2024-08-07 09:21:16 +01:00
)
```
<div class="result" markdown>
Add ComparisonAnnotator docs, remove Crop & RoundBox annotator from preview * Up to 20 tabs can be made at once. This is likely a bug relating to the underlying mkdocs plugin, but a quick check for hardcoded values yielded nothing.
2024-12-11 16:58:36 +02:00
![background-overlay-annotator-example](https://media.roboflow.com/supervision-annotator-examples/background-color-annotator-example-purple.png){ align=center width="800" }
</div>
=== "Comparison"
```python
import supervision as sv
image = ...
detections_1 = sv.Detections(...)
detections_2 = sv.Detections(...)
comparison_annotator = sv.ComparisonAnnotator()
annotated_frame = comparison_annotator.annotate(
scene=image.copy(),
detections_1=detections_1,
docs: Wrap all placeholder paths in quotes and code expressions (#2128) * Wrap all placeholder paths in quotes across documentation and code examples for consistency * Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 22:00:40 +09:00
detections_2=detections_2,
Add ComparisonAnnotator docs, remove Crop & RoundBox annotator from preview * Up to 20 tabs can be made at once. This is likely a bug relating to the underlying mkdocs plugin, but a quick check for hardcoded values yielded nothing.
2024-12-11 16:58:36 +02:00
)
```
<div class="result" markdown>
Chore CI by adding checks for links and references (#2113) * Chore CI by adding checks for links and references * Potential fix for code scanning alert no. 6: Workflow does not contain permissions * Fix markdown image formatting in metrics documentation * Update all `docs` links to use absolute URLs and fix broken references in documentation and workflows. * Fix broken `albumentations` links in dataset processing documentation * lycheeVersion: v0.22.0 * Refactor CI link check workflow to use lychee config file for cleaner argument management * add TODOs for future file type support * Fix header formatting for example plots across metric files --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-03 01:01:19 +09:00
![comparison-annotator-example](https://media.roboflow.com/supervision-annotator-examples/comparison-annotator-example.png){ align=center width="800" }
Fix annotator carousel image
2024-08-07 17:29:01 +03:00
add BackgroundColorAnnotator docs
2024-08-07 09:21:16 +01:00
</div>
moves embedded widget to below the tabs and passes necessary query params to render new layout
2024-10-02 21:09:58 -03:00
<div class="md-typeset">
Update annotators.md being concise is a virtue
2024-10-03 13:29:14 -07:00
<h2>Try Supervision Annotators on your own image</h2>
Visualize annotators on images with COCO classes such as people, vehicles, animals, household items.
moves embedded widget to below the tabs and passes necessary query params to render new layout
2024-10-02 21:09:58 -03:00
</div>
<div style="height: 400px; width: 100%; border-radius: 8px; overflow: hidden;"><iframe src="https://app.roboflow.com/workflows/embed/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ3b3JrZmxvd0lkIjoiNDdtd2xuWW16S25VNWtOYUZjMG8iLCJ3b3Jrc3BhY2VJZCI6ImtyT1RBYm5jRmhvUU1DZExPbGU0IiwidXNlcklkIjoiRVJNUFBZY3FQMmZWWjB1NkRpNXZaYXJDdlZPMiIsImlhdCI6MTcyNjgzOTM2N30.gj2F6SnmmURAScJe4PTC1raUXsAK5mZyrUIGIJ44NhM?hideToolbar=true&hideHeader=true&defaultVisual=true" loading="lazy" title="Roboflow Workflow for Supervision Annotators" style="width: 100%; height: 100%; min-height: 400px; border: none;"></iframe></div>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
Deprecate BoundingBoxAnnotator, rename to BoxAnnotator
2024-07-12 18:18:50 +03:00
<h2><a href="#supervision.annotators.core.BoxAnnotator">BoxAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
Deprecate BoundingBoxAnnotator, rename to BoxAnnotator
2024-07-12 18:18:50 +03:00
:::supervision.annotators.core.BoxAnnotator
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.RoundBoxAnnotator">RoundBoxAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
docs: 📝 PercentageBar Annotator docs and usage added. Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-22 21:52:56 +03:00
:::supervision.annotators.core.RoundBoxAnnotator
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.BoxCornerAnnotator">BoxCornerAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
:::supervision.annotators.core.BoxCornerAnnotator
docs: 📝 OrientedBox Annotator docs added Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-23 21:07:09 +03:00
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.OrientedBoxAnnotator">OrientedBoxAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
docs: 📝 OrientedBox Annotator docs added Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-23 21:07:09 +03:00
:::supervision.annotators.core.OrientedBoxAnnotator
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.ColorAnnotator">ColorAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
rename BoxMaskAnnotator to ColorAnnotator
2023-12-05 10:38:32 +00:00
:::supervision.annotators.core.ColorAnnotator
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.CircleAnnotator">CircleAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
:::supervision.annotators.core.CircleAnnotator
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.DotAnnotator">DotAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Expand and update Color, ColorPalette, and DotAnnotator classes Added detailed comments and examples to the Color and ColorPalette classes in supervision/draw/color.py, in addition to the DotAnnotator class in supervision/annotators/core.py. The changes clarify the usage and function of these classes. Also appended to the documentation by creating a new section for Color in docs/draw/color.md and including Color and DotAnnotator in docs/annotators.md. Incorporated the new documentation into the navigation structure in mkdocs.yml for user accessibility. The improvements enhance overall code-readability and understandability.
2023-10-18 18:53:39 +02:00
:::supervision.annotators.core.DotAnnotator
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.TriangleAnnotator">TriangleAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Add TriangleAnnotator example to documentation
2023-12-06 13:59:05 +01:00
:::supervision.annotators.core.TriangleAnnotator
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.EllipseAnnotator">EllipseAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Refactor documentation structure and improve annotator details Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
:::supervision.annotators.core.EllipseAnnotator
Add TraceAnnotator description to the documentation The documentation has been updated to include the `TraceAnnotator` class.
2023-10-04 15:35:07 +02:00
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.HaloAnnotator">HaloAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Update example images and modify code parameters
2023-10-09 16:15:35 +02:00
:::supervision.annotators.core.HaloAnnotator
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.PercentageBarAnnotator">PercentageBarAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
docs: 📝 PercentageBar Annotator docs and usage added. Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-22 21:52:56 +03:00
:::supervision.annotators.core.PercentageBarAnnotator
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.HeatMapAnnotator">HeatMapAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Update example code blocks in `core.py` and `annotators.md` Code examples in `supervision/annotators/core.py` and `docs/annotators.md` have been updated for clarity and consistency. The changes include renaming variables more appropriately and elaborating on the video processing steps which now includes tracking and annotating frames using a YOLO model. This revision aims to make examples more understandable and consistent for users following the documentation.
2023-10-18 21:25:44 +02:00
:::supervision.annotators.core.HeatMapAnnotator
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.MaskAnnotator">MaskAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Add TraceAnnotator description to the documentation The documentation has been updated to include the `TraceAnnotator` class.
2023-10-04 15:35:07 +02:00
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
:::supervision.annotators.core.MaskAnnotator
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.PolygonAnnotator">PolygonAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Add PolygonAnnotator and update documentation Implemented the PolygonAnnotator class in the core.py file under the supervision/annotators directory to support drawing polygons over detected objects. This was done by dividing the masks into multiple polygons and drawing them on the image.
2023-11-15 17:09:27 +01:00
:::supervision.annotators.core.PolygonAnnotator
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.LabelAnnotator">LabelAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
:::supervision.annotators.core.LabelAnnotator
Refactor BlurAnnotator class and update documentation
2023-10-04 23:50:47 +02:00
docs: 📝 RichLabelAnnotator documentation added into docs and minor var fixes Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-05-15 18:35:36 +03:00
<div class="md-typeset">
<h2><a href="#supervision.annotators.core.RichLabelAnnotator">RichLabelAnnotator</a></h2>
</div>
:::supervision.annotators.core.RichLabelAnnotator
Merge branch 'develop' into dfreilich/add-icon-annotator
2024-08-15 11:38:13 +03:00
<div class="md-typeset">
<h2><a href="#supervision.annotators.core.IconAnnotator">IconAnnotator</a></h2>
</div>
:::supervision.annotators.core.IconAnnotator
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.BlurAnnotator">BlurAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Refactor BlurAnnotator class and update documentation
2023-10-04 23:50:47 +02:00
fix(pre_commit): 🎨 auto format pre-commit hooks
2023-10-04 21:52:49 +00:00
:::supervision.annotators.core.BlurAnnotator
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.PixelateAnnotator">PixelateAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Refactor PixelateAnnotator and update docs
2023-12-05 12:03:59 +01:00
:::supervision.annotators.core.PixelateAnnotator
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.TraceAnnotator">TraceAnnotator</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Update annotators in docs and code
2023-10-06 20:51:31 +02:00
fix(pre_commit): 🎨 auto format pre-commit hooks
2023-10-06 18:52:00 +00:00
:::supervision.annotators.core.TraceAnnotator
Expand and update Color, ColorPalette, and DotAnnotator classes Added detailed comments and examples to the Color and ColorPalette classes in supervision/draw/color.py, in addition to the DotAnnotator class in supervision/annotators/core.py. The changes clarify the usage and function of these classes. Also appended to the documentation by creating a new section for Color in docs/draw/color.md and including Color and DotAnnotator in docs/annotators.md. Incorporated the new documentation into the navigation structure in mkdocs.yml for user accessibility. The improvements enhance overall code-readability and understandability.
2023-10-18 18:53:39 +02:00
Remove acceptance tests * Update docs
2024-02-22 19:52:51 +02:00
<div class="md-typeset">
add CropAnnotator docs
2024-03-14 14:43:19 +01:00
<h2><a href="#supervision.annotators.core.CropAnnotator">CropAnnotator</a></h2>
Remove acceptance tests * Update docs
2024-02-22 19:52:51 +02:00
</div>
add CropAnnotator docs
2024-03-14 14:43:19 +01:00
:::supervision.annotators.core.CropAnnotator
add BackgroundColorAnnotator docs
2024-08-07 09:21:16 +01:00
<div class="md-typeset">
Rename to BackgoundOverlayAnnotator, fix return after copy
2024-08-07 16:39:22 +03:00
<h2><a href="#supervision.annotators.core.BackgroundOverlayAnnotator">BackgroundOverlayAnnotator</a></h2>
add BackgroundColorAnnotator docs
2024-08-07 09:21:16 +01:00
</div>
Rename to BackgoundOverlayAnnotator, fix return after copy
2024-08-07 16:39:22 +03:00
:::supervision.annotators.core.BackgroundOverlayAnnotator
Remove acceptance tests * Update docs
2024-02-22 19:52:51 +02:00
Add ComparisonAnnotator docs, remove Crop & RoundBox annotator from preview * Up to 20 tabs can be made at once. This is likely a bug relating to the underlying mkdocs plugin, but a quick check for hardcoded values yielded nothing.
2024-12-11 16:58:36 +02:00
<div class="md-typeset">
<h2><a href="#supervision.annotators.core.ComparisonAnnotator">ComparisonAnnotator</a></h2>
</div>
:::supervision.annotators.core.ComparisonAnnotator
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
<div class="md-typeset">
docs(link): annotators now has proper linking Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 20:23:11 +03:00
<h2><a href="#supervision.annotators.core.ColorLookup">ColorLookup</a></h2>
docs(fix): 🐞📝 removal of table of content duplicates annotators Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:56:08 +03:00
</div>
Expand and update Color, ColorPalette, and DotAnnotator classes Added detailed comments and examples to the Color and ColorPalette classes in supervision/draw/color.py, in addition to the DotAnnotator class in supervision/annotators/core.py. The changes clarify the usage and function of these classes. Also appended to the documentation by creating a new section for Color in docs/draw/color.md and including Color and DotAnnotator in docs/annotators.md. Incorporated the new documentation into the navigation structure in mkdocs.yml for user accessibility. The improvements enhance overall code-readability and understandability.
2023-10-18 18:53:39 +02:00
:::supervision.annotators.utils.ColorLookup
Reference in New Issue Copy Permalink