Merge pull request #392 from roboflow/docs/documentation-refactoring

Refactor documentation structure and improve annotator details

Author: SkalskiP

docs/annotators.md

@@ -0,0 +1,149 @@
+=== "BoundingBox"
+
+    ```python
+    >>> import supervision as sv
+
+    >>> image = ...
+    >>> detections = sv.Detections(...)
+
+    >>> bounding_box_annotator = sv.BoundingBoxAnnotator()
+    >>> annotated_frame = bounding_box_annotator.annotate(
+    ...     scene=image.copy(),
+    ...     detections=detections
+    ... )
+    ```
+
+    <div class="result" markdown>
+
+    ![bounding-box-annotator-example](https://media.roboflow.com/supervision-annotator-examples/bounding-box-annotator-example.png){ align=center width="800" }
+
+    </div>
+
+=== "Mask"
+
+    ```python
+    >>> import supervision as sv
+
+    >>> image = ...
+    >>> detections = sv.Detections(...)
+
+    >>> mask_annotator = sv.MaskAnnotator()
+    >>> annotated_frame = mask_annotator.annotate(
+    ...     scene=image.copy(),
+    ...     detections=detections
+    ... )
+    ```
+
+    <div class="result" markdown>
+
+    ![mask-annotator-example](https://media.roboflow.com/supervision-annotator-examples/mask-annotator-example.png){ align=center width="800" }
+
+    </div>
+
+=== "Ellipse"
+
+    ```python
+    >>> import supervision as sv
+
+    >>> image = ...
+    >>> detections = sv.Detections(...)
+
+    >>> ellipse_annotator = sv.EllipseAnnotator()
+    >>> annotated_frame = ellipse_annotator.annotate(
+    ...     scene=image.copy(),
+    ...     detections=detections
+    ... )
+    ```
+
+    <div class="result" markdown>
+
+    ![ellipse-annotator-example](https://media.roboflow.com/supervision-annotator-examples/ellipse-annotator-example.png){ align=center width="800" }
+
+    </div>
+
+=== "BoxCorner"
+
+    ```python
+    >>> import supervision as sv
+
+    >>> image = ...
+    >>> detections = sv.Detections(...)
+
+    >>> corner_annotator = sv.BoxCornerAnnotator()
+    >>> annotated_frame = corner_annotator.annotate(
+    ...     scene=image.copy(),
+    ...     detections=detections
+    ... )
+    ```
+
+    <div class="result" markdown>
+
+    ![box-corner-annotator-example](https://media.roboflow.com/supervision-annotator-examples/box-corner-annotator-example.png){ align=center width="800" }
+
+    </div>
+
+=== "Circle"
+
+    ```python
+    >>> import supervision as sv
+
+    >>> image = ...
+    >>> detections = sv.Detections(...)
+
+    >>> circle_annotator = sv.CircleAnnotator()
+    >>> annotated_frame = circle_annotator.annotate(
+    ...     scene=image.copy(),
+    ...     detections=detections
+    ... )
+    ```
+
+    <div class="result" markdown>
+
+    ![circle-annotator-example](https://media.roboflow.com/supervision-annotator-examples/circle-annotator-example.png){ align=center width="800" }
+
+    </div>
+
+=== "Label"
+
+    ```python
+    >>> import supervision as sv
+
+    >>> image = ...
+    >>> detections = sv.Detections(...)
+
+    >>> label_annotator = sv.LabelAnnotator(text_position=sv.Position.CENTER)
+    >>> annotated_frame = label_annotator.annotate(
+    ...     scene=image.copy(),
+    ...     detections=detections
+    ... )
+    ```
+
+    <div class="result" markdown>
+
+    ![label-annotator-example](https://media.roboflow.com/supervision-annotator-examples/label-annotator-example-2.png){ align=center width="800" }
+
+    </div>
+
+## BoundingBoxAnnotator
+
+:::supervision.annotators.core.BoundingBoxAnnotator
+
+## MaskAnnotator
+
+:::supervision.annotators.core.MaskAnnotator
+
+## EllipseAnnotator
+
+:::supervision.annotators.core.EllipseAnnotator
+
+## BoxCornerAnnotator
+
+:::supervision.annotators.core.BoxCornerAnnotator
+
+## CircleAnnotator
+
+:::supervision.annotators.core.CircleAnnotator
+
+## LabelAnnotator
+
+:::supervision.annotators.core.LabelAnnotator

docs/dataset/core.md renamed to docs/datasets.md

@@ -28,29 +28,27 @@ nav:
   - Home: index.md
   - Quickstart:
     - Detections: quickstart/detections.md
-  - API reference:
-    - Classifications:
-        - Core: classification/core.md
-    - Detections:
-        - Core: detection/core.md
-        - Annotate: detection/annotate.md
-        - Utils: detection/utils.md
-        - Tools:
-            - Polygon Zone: detection/tools/polygon_zone.md
-            - Inference Slicer: detection/tools/inference_slicer.md
-    - Trackers:
-        - Core: tracker/core.md
-    - Dataset:
-        - Core: dataset/core.md
-    - Metrics:
-      - Detection Models: metrics/detection.md
-    - Draw:
-        - Utils: draw/utils.md
-    - Utils:
-        - Video: utils/video.md
-        - Image: utils/image.md
-        - Notebook: utils/notebook.md
-        - File: utils/file.md
+  - Classifications:
+      - Core: classification/core.md
+  - Detections:
+      - Core: detection/core.md
+      - Annotate: detection/annotate.md
+      - Utils: detection/utils.md
+      - Tools:
+          - Polygon Zone: detection/tools/polygon_zone.md
+          - Inference Slicer: detection/tools/inference_slicer.md
+  - Annotators: annotators.md
+  - Trackers: trackers.md
+  - Datasets: datasets.md
+  - Metrics:
+    - Object Detection: metrics/detection.md
+  - Draw:
+      - Utils: draw/utils.md
+  - Utils:
+      - Video: utils/video.md
+      - Image: utils/image.md
+      - Notebook: utils/notebook.md
+      - File: utils/file.md
   - Changelog: changelog.md
 
 theme:

docs/detection/annotate.md

@@ -346,13 +346,15 @@ def annotate(
         detections: Detections,
     ) -> np.ndarray:
         """
-        Draws circle on the frame using the detections provided.
+        Annotates the given scene with circles based on the provided detections.
+
         Args:
-            scene (np.ndarray): The image on which the circle will be drawn
-            detections (Detections): The detections for which the
-                circle will be drawn
+            scene (np.ndarray): The image where box corners will be drawn.
+            detections (Detections): Object detections to annotate.
+
         Returns:
-            np.ndarray: The image with the circle drawn on it
+            np.ndarray: The annotated image.
+
         Example:
             ```python
             >>> import supervision as sv