superiorvision 0.30.0.dev0__py3-none-any.whl

supervision/__init__.py

@@ -0,0 +1,318 @@
+import importlib.metadata as importlib_metadata
+from typing import TYPE_CHECKING, Any
+
+try:
+    # This will read version from pyproject.toml
+    __version__ = importlib_metadata.version("superiorvision")
+except importlib_metadata.PackageNotFoundError:
+    __version__ = "development"
+
+from supervision.annotators.core import (
+    BackgroundOverlayAnnotator,
+    BlurAnnotator,
+    BoxAnnotator,
+    BoxCornerAnnotator,
+    CircleAnnotator,
+    ColorAnnotator,
+    ComparisonAnnotator,
+    CropAnnotator,
+    DotAnnotator,
+    EllipseAnnotator,
+    HaloAnnotator,
+    HeatMapAnnotator,
+    IconAnnotator,
+    LabelAnnotator,
+    MaskAnnotator,
+    OrientedBoxAnnotator,
+    PercentageBarAnnotator,
+    PixelateAnnotator,
+    PolygonAnnotator,
+    RichLabelAnnotator,
+    RoundBoxAnnotator,
+    TraceAnnotator,
+    TriangleAnnotator,
+)
+from supervision.annotators.utils import (
+    ColorLookup,
+    hex_to_rgba,
+    is_valid_hex,
+    rgba_to_hex,
+)
+from supervision.classification.core import Classifications
+from supervision.dataset.core import (
+    BaseDataset,
+    ClassificationDataset,
+    DetectionDataset,
+)
+from supervision.dataset.formats.coco import get_coco_class_index_mapping
+from supervision.detection.compact_mask import CompactMask
+from supervision.detection.core import Detections
+from supervision.detection.line_zone import (
+    LineZone,
+    LineZoneAnnotator,
+    LineZoneAnnotatorMulticlass,
+)
+from supervision.detection.overlap_filter import (
+    box_non_max_merge,
+    box_non_max_suppression,
+    mask_non_max_merge,
+    mask_non_max_suppression,
+)
+from supervision.detection.tensor_utils import (
+    box_iou_batch,
+    calculate_masks_centroids,
+    clip_boxes,
+    mask_iou_batch,
+    mask_to_polygons,
+    mask_to_xyxy,
+    move_boxes,
+    move_masks,
+    oriented_box_iou_batch,
+    pad_boxes,
+    polygon_to_mask,
+    polygon_to_xyxy,
+    scale_boxes,
+    xcycwh_to_xyxy,
+    xywh_to_xyxy,
+    xyxy_to_polygons,
+)
+from supervision.detection.tools.csv_sink import CSVSink
+from supervision.detection.tools.inference_slicer import (
+    InferenceSlicer,
+    WindowedRasterDataset,
+)
+from supervision.detection.tools.json_sink import JSONSink
+from supervision.detection.tools.polygon_zone import PolygonZone, PolygonZoneAnnotator
+from supervision.detection.tools.smoother import DetectionsSmoother
+from supervision.detection.utils.boxes import (
+    denormalize_boxes,
+    xyxyxyxy_to_xyxy,
+)
+from supervision.detection.utils.converters import (
+    is_compressed_rle,
+    mask_to_rle,
+    rle_to_mask,
+    xyxy_to_mask,
+    xyxy_to_xcycarh,
+    xyxy_to_xywh,
+)
+from supervision.detection.utils.iou_and_nms import (
+    OverlapFilter,
+    OverlapMetric,
+    box_iou,
+    box_iou_batch_with_jaccard,
+    oriented_box_non_max_merge,
+    oriented_box_non_max_suppression,
+)
+from supervision.detection.utils.masks import (
+    contains_holes,
+    contains_multiple_segments,
+    filter_segments_by_distance,
+    mask_to_roi,
+)
+from supervision.detection.utils.polygons import (
+    approximate_polygon,
+    filter_polygons_by_area,
+)
+from supervision.detection.utils.vlms import edit_distance, fuzzy_match_index
+from supervision.detection.vlm import LMM, VLM
+from supervision.draw.color import Color, ColorPalette
+from supervision.draw.utils import (
+    calculate_optimal_line_thickness,
+    calculate_optimal_text_scale,
+    draw_filled_polygon,
+    draw_filled_rectangle,
+    draw_image,
+    draw_line,
+    draw_polygon,
+    draw_rectangle,
+    draw_text,
+)
+from supervision.geometry.core import Point, Position, Rect
+from supervision.geometry.utils import get_polygon_center
+from supervision.key_points.annotators import (
+    EdgeAnnotator,
+    VertexAnnotator,
+    VertexEllipseAnnotator,
+    VertexEllipseAreaAnnotator,
+    VertexEllipseHaloAnnotator,
+    VertexEllipseOutlineAnnotator,
+    VertexLabelAnnotator,
+)
+from supervision.key_points.core import KeyPoints
+from supervision.metrics.detection import ConfusionMatrix, MeanAveragePrecision
+from supervision.utils.conversion import cv2_to_pillow, pillow_to_cv2
+from supervision.utils.file import list_files_with_extensions
+from supervision.utils.image import (
+    ImageSink,
+    crop_image,
+    get_image_resolution_wh,
+    grayscale_image,
+    letterbox_image,
+    overlay_image,
+    resize_image,
+    scale_image,
+    tint_image,
+)
+from supervision.utils.notebook import plot_image, plot_images_grid
+from supervision.utils.video import (
+    FPSMonitor,
+    VideoInfo,
+    VideoSink,
+    get_video_frames_generator,
+    process_video,
+)
+
+# Inference still imports the pre-0.30 name. The implementation was renamed
+# upstream without changing its constructor or annotation contract.
+BackgroundColorAnnotator = BackgroundOverlayAnnotator
+
+if TYPE_CHECKING:
+    from supervision.tracker.byte_tracker.core import ByteTrack
+
+__all__ = [
+    "LMM",
+    "VLM",
+    "BackgroundColorAnnotator",
+    "BackgroundOverlayAnnotator",
+    "BaseDataset",
+    "BlurAnnotator",
+    "BoxAnnotator",
+    "BoxCornerAnnotator",
+    "ByteTrack",
+    "CSVSink",
+    "CircleAnnotator",
+    "ClassificationDataset",
+    "Classifications",
+    "Color",
+    "ColorAnnotator",
+    "ColorLookup",
+    "ColorPalette",
+    "CompactMask",
+    "ComparisonAnnotator",
+    "ConfusionMatrix",
+    "CropAnnotator",
+    "DetectionDataset",
+    "Detections",
+    "DetectionsSmoother",
+    "DotAnnotator",
+    "EdgeAnnotator",
+    "EllipseAnnotator",
+    "FPSMonitor",
+    "HaloAnnotator",
+    "HeatMapAnnotator",
+    "IconAnnotator",
+    "ImageSink",
+    "InferenceSlicer",
+    "JSONSink",
+    "KeyPoints",
+    "LabelAnnotator",
+    "LineZone",
+    "LineZoneAnnotator",
+    "LineZoneAnnotatorMulticlass",
+    "MaskAnnotator",
+    "MeanAveragePrecision",
+    "OrientedBoxAnnotator",
+    "OverlapFilter",
+    "OverlapMetric",
+    "PercentageBarAnnotator",
+    "PixelateAnnotator",
+    "Point",
+    "PolygonAnnotator",
+    "PolygonZone",
+    "PolygonZoneAnnotator",
+    "Position",
+    "Rect",
+    "RichLabelAnnotator",
+    "RoundBoxAnnotator",
+    "TraceAnnotator",
+    "TriangleAnnotator",
+    "VertexAnnotator",
+    "VertexEllipseAnnotator",
+    "VertexEllipseAreaAnnotator",
+    "VertexEllipseHaloAnnotator",
+    "VertexEllipseOutlineAnnotator",
+    "VertexLabelAnnotator",
+    "VideoInfo",
+    "VideoSink",
+    "WindowedRasterDataset",
+    "approximate_polygon",
+    "box_iou",
+    "box_iou_batch",
+    "box_iou_batch_with_jaccard",
+    "box_non_max_merge",
+    "box_non_max_suppression",
+    "calculate_masks_centroids",
+    "calculate_optimal_line_thickness",
+    "calculate_optimal_text_scale",
+    "clip_boxes",
+    "contains_holes",
+    "contains_multiple_segments",
+    "crop_image",
+    "cv2_to_pillow",
+    "denormalize_boxes",
+    "draw_filled_polygon",
+    "draw_filled_rectangle",
+    "draw_image",
+    "draw_line",
+    "draw_polygon",
+    "draw_rectangle",
+    "draw_text",
+    "edit_distance",
+    "filter_polygons_by_area",
+    "filter_segments_by_distance",
+    "fuzzy_match_index",
+    "get_coco_class_index_mapping",
+    "get_image_resolution_wh",
+    "get_polygon_center",
+    "get_video_frames_generator",
+    "grayscale_image",
+    "hex_to_rgba",
+    "is_compressed_rle",
+    "is_valid_hex",
+    "letterbox_image",
+    "list_files_with_extensions",
+    "mask_iou_batch",
+    "mask_non_max_merge",
+    "mask_non_max_suppression",
+    "mask_to_polygons",
+    "mask_to_rle",
+    "mask_to_roi",
+    "mask_to_xyxy",
+    "move_boxes",
+    "move_masks",
+    "oriented_box_iou_batch",
+    "oriented_box_non_max_merge",
+    "oriented_box_non_max_suppression",
+    "overlay_image",
+    "pad_boxes",
+    "pillow_to_cv2",
+    "plot_image",
+    "plot_images_grid",
+    "polygon_to_mask",
+    "polygon_to_xyxy",
+    "process_video",
+    "resize_image",
+    "rgba_to_hex",
+    "rle_to_mask",
+    "scale_boxes",
+    "scale_image",
+    "tint_image",
+    "xcycwh_to_xyxy",
+    "xywh_to_xyxy",
+    "xyxy_to_mask",
+    "xyxy_to_polygons",
+    "xyxy_to_xcycarh",
+    "xyxy_to_xywh",
+    "xyxyxyxy_to_xyxy",
+]
+
+
+def __getattr__(name: str) -> Any:
+    """Lazily resolve deprecated compatibility exports."""
+    if name == "ByteTrack":
+        from supervision.tracker.byte_tracker.core import ByteTrack as byte_track
+
+        globals()[name] = byte_track
+        return byte_track
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

supervision/annotators/base.py

@@ -0,0 +1,21 @@
+from abc import ABC, abstractmethod
+from typing import Any
+
+from supervision.detection.core import Detections
+
+
+class BaseAnnotator(ABC):
+    """Base class for annotators that consume :class:`Detections`.
+
+    Attributes:
+        requires_mask: Whether integrations must provide ``Detections.mask`` for
+            this annotator. Check this before materializing expensive mask payloads.
+    """
+
+    requires_mask: bool = False
+
+    @abstractmethod
+    def annotate(
+        self, scene: Any, detections: Detections, *args: Any, **kwargs: Any
+    ) -> Any:
+        pass