@@ -26,16 +26,16 @@ comments: true
=== "RoundBox"
```python
- import supervision as sv
+ import supervision as sv
- image = ...
- detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- round_box_annotator = sv.RoundBoxAnnotator()
- annotated_frame = round_box_annotator.annotate(
- scene=image.copy(),
- detections=detections
- )
+ round_box_annotator = sv.RoundBoxAnnotator()
+ annotated_frame = round_box_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
@@ -54,9 +54,9 @@ comments: true
corner_annotator = sv.BoxCornerAnnotator()
annotated_frame = corner_annotator.annotate(
- scene=image.copy(),
- detections=detections
- )
+ scene=image.copy(),
+ detections=detections
+ )
```
diff --git a/supervision/annotators/core.py b/supervision/annotators/core.py
index 9ae81c95..7960d7ec 100644
--- a/supervision/annotators/core.py
+++ b/supervision/annotators/core.py
@@ -57,16 +57,16 @@ class BoundingBoxAnnotator(BaseAnnotator):
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> bounding_box_annotator = sv.BoundingBoxAnnotator()
- >>> annotated_frame = bounding_box_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ bounding_box_annotator = sv.BoundingBoxAnnotator()
+ annotated_frame = bounding_box_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
:
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> mask_annotator = sv.MaskAnnotator()
- >>> annotated_frame = mask_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ mask_annotator = sv.MaskAnnotator()
+ annotated_frame = mask_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
:
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> polygon_annotator = sv.PolygonAnnotator()
- >>> annotated_frame = polygon_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ polygon_annotator = sv.PolygonAnnotator()
+ annotated_frame = polygon_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
:
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> color_annotator = sv.ColorAnnotator()
- >>> annotated_frame = color_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ color_annotator = sv.ColorAnnotator()
+ annotated_frame = color_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
:
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> halo_annotator = sv.HaloAnnotator()
- >>> annotated_frame = halo_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ halo_annotator = sv.HaloAnnotator()
+ annotated_frame = halo_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
:
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> ellipse_annotator = sv.EllipseAnnotator()
- >>> annotated_frame = ellipse_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ ellipse_annotator = sv.EllipseAnnotator()
+ annotated_frame = ellipse_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
:
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> corner_annotator = sv.BoxCornerAnnotator()
- >>> annotated_frame = corner_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ corner_annotator = sv.BoxCornerAnnotator()
+ annotated_frame = corner_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
:
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> circle_annotator = sv.CircleAnnotator()
- >>> annotated_frame = circle_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ circle_annotator = sv.CircleAnnotator()
+ annotated_frame = circle_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
@@ -745,16 +745,16 @@ class DotAnnotator(BaseAnnotator):
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> dot_annotator = sv.DotAnnotator()
- >>> annotated_frame = dot_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ dot_annotator = sv.DotAnnotator()
+ annotated_frame = dot_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```

+ image = ...
+ detections = sv.Detections(...)
- >>> label_annotator = sv.LabelAnnotator(text_position=sv.Position.CENTER)
- >>> annotated_frame = label_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ label_annotator = sv.LabelAnnotator(text_position=sv.Position.CENTER)
+ annotated_frame = label_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
:
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> blur_annotator = sv.BlurAnnotator()
- >>> annotated_frame = circle_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ blur_annotator = sv.BlurAnnotator()
+ annotated_frame = circle_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```

+ model = YOLO('yolov8x.pt')
+ trace_annotator = sv.TraceAnnotator()
- >>> trace_annotator = sv.TraceAnnotator()
+ video_info = sv.VideoInfo.from_video_path(video_path='...')
+ frames_generator = sv.get_video_frames_generator(source_path='...')
+ tracker = sv.ByteTrack()
- >>> video_info = sv.VideoInfo.from_video_path(video_path='...')
- >>> frames_generator = sv.get_video_frames_generator(source_path='...')
- >>> tracker = sv.ByteTrack()
-
- >>> with sv.VideoSink(target_path='...', video_info=video_info) as sink:
- ... 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(),
- ... detections=detections)
- ... sink.write_frame(frame=annotated_frame)
+ with sv.VideoSink(target_path='...', video_info=video_info) as sink:
+ 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(),
+ detections=detections)
+ sink.write_frame(frame=annotated_frame)
```

+ model = YOLO('yolov8x.pt')
- >>> heat_map_annotator = sv.HeatMapAnnotator()
+ heat_map_annotator = sv.HeatMapAnnotator()
- >>> video_info = sv.VideoInfo.from_video_path(video_path='...')
- >>> frames_generator = get_video_frames_generator(source_path='...')
+ video_info = sv.VideoInfo.from_video_path(video_path='...')
+ frames_generator = get_video_frames_generator(source_path='...')
- >>> with sv.VideoSink(target_path='...', video_info=video_info) as sink:
- ... for frame in frames_generator:
- ... result = model(frame)[0]
- ... detections = sv.Detections.from_ultralytics(result)
- ... annotated_frame = heat_map_annotator.annotate(
- ... scene=frame.copy(),
- ... detections=detections)
- ... sink.write_frame(frame=annotated_frame)
+ with sv.VideoSink(target_path='...', video_info=video_info) as sink:
+ for frame in frames_generator:
+ result = model(frame)[0]
+ detections = sv.Detections.from_ultralytics(result)
+ annotated_frame = heat_map_annotator.annotate(
+ scene=frame.copy(),
+ detections=detections)
+ sink.write_frame(frame=annotated_frame)
```
:
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> pixelate_annotator = sv.PixelateAnnotator()
- >>> annotated_frame = pixelate_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ pixelate_annotator = sv.PixelateAnnotator()
+ annotated_frame = pixelate_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
:
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> triangle_annotator = sv.TriangleAnnotator()
- >>> annotated_frame = triangle_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ triangle_annotator = sv.TriangleAnnotator()
+ annotated_frame = triangle_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
:
Example:
```python
- >>> import supervision as sv
+ import supervision as sv
- >>> image = ...
- >>> detections = sv.Detections(...)
+ image = ...
+ detections = sv.Detections(...)
- >>> round_box_annotator = sv.RoundBoxAnnotator()
- >>> annotated_frame = round_box_annotator.annotate(
- ... scene=image.copy(),
- ... detections=detections
- ... )
+ round_box_annotator = sv.RoundBoxAnnotator()
+ annotated_frame = round_box_annotator.annotate(
+ scene=image.copy(),
+ detections=detections
+ )
```
![round-box-annotator-example](https://media.roboflow.com/