MCPcopy Index your code

hub / github.com/roboflow/supervision / types & classes

Types & classes220 in github.com/roboflow/supervision

↓ 166 callersClassDetections
The `sv.Detections` class in the Supervision library standardizes results from various object detection and segmentation models into a consis
src/supervision/detection/core.py:68
↓ 21 callersClassF1Score
F1 Score is a metric used to evaluate object detection models. It is the harmonic mean of precision and recall, calculated at different IoU t
src/supervision/metrics/f1_score.py:30
↓ 20 callersClassCompactMask
Memory-efficient crop-RLE mask storage for instance segmentation. Instead of storing N full ``(H, W)`` boolean arrays, :class:`CompactMask` e
src/supervision/detection/compact_mask.py:389
↓ 17 callersClassPrecision
Precision is a metric used to evaluate object detection models. It is the ratio of true positive detections to the total number of predicted
src/supervision/metrics/precision.py:30
↓ 16 callersClassRecall
Recall is a metric used to evaluate object detection models. It is the ratio of true positive detections to the total number of ground truth
src/supervision/metrics/recall.py:30
↓ 15 callersClassDetectionDataset
Contains information about a detection dataset. Handles lazy image loading and annotation retrieval, dataset splitting, conversions into mult
src/supervision/dataset/core.py:56
↓ 15 callersClassPoint
Represents a point in 2D space. Attributes: x: The x-coordinate of the point. y: The y-coordinate of the point. Example
src/supervision/geometry/core.py:30
↓ 14 callersClassMeanAveragePrecision
Mean Average Precision (mAP) is a metric used to evaluate object detection models. It is the average of the precision-recall curves at differ
src/supervision/metrics/mean_average_precision.py:1226
↓ 9 callersClassInferenceSlicer
Perform tiled inference on large images by slicing them into overlapping patches. This class divides an input image into overlapping slices
src/supervision/detection/tools/inference_slicer.py:64
↓ 9 callersClassKeyPoints
The `sv.KeyPoints` class in the Supervision library standardizes results from various keypoint detection and pose estimation models into a co
src/supervision/key_points/core.py:75
↓ 8 callersClassTraceAnnotator
A class for drawing trace paths on an image based on detection coordinates. !!! warning This annotator uses the `sv.Detections.trac
src/supervision/annotators/core.py:1974
↓ 7 callersClassLineZone
This class is responsible for counting the number of objects that cross a predefined line. <video controls> <source
src/supervision/detection/line_zone.py:26
↓ 7 callersClassPixelateAnnotator
A class for pixelating regions in an image using provided detections.
src/supervision/annotators/core.py:2231
↓ 6 callersClassClockBasedTimer
A timer that calculates the duration each object has been detected based on the system clock. Attributes: tracker_id2start_time
examples/time_in_zone/utils/timers.py:54
↓ 6 callersClass_FakeTensor
Minimal tensor wrapper for cpu().numpy() and int().
tests/helpers.py:248
↓ 5 callersClassHaloAnnotator
A class for drawing Halos on an image using provided detections. !!! warning This annotator uses `sv.Detections.mask`.
src/supervision/annotators/core.py:698
↓ 5 callersClassMaskAnnotator
A class for drawing masks on an image using provided detections. !!! warning This annotator uses `sv.Detections.mask`.
src/supervision/annotators/core.py:423
↓ 5 callersClassMeanAverageRecall
Mean Average Recall (mAR) measures how well the model detects and retrieves relevant objects by averaging recall over multiple IoU thresh
src/supervision/metrics/mean_average_recall.py:259
↓ 5 callersClassRect
Represents a rectangle in 2D space. Attributes: x: The x-coordinate of the top-left corner of the rectangle. y: The y-coordi
src/supervision/geometry/core.py:146
↓ 4 callersClassBlurAnnotator
A class for blurring regions in an image using provided detections.
src/supervision/annotators/core.py:1897
↓ 4 callersClassBoxAnnotator
A class for drawing bounding boxes on an image using provided detections.
src/supervision/annotators/core.py:190
↓ 4 callersClassDetectionsSmoother
A utility class for smoothing detections over multiple frames in video tracking. It maintains a history of detections for each track and prov
src/supervision/detection/tools/smoother.py:14
↓ 4 callersClassHeatMapAnnotator
A class for drawing heatmaps on an image based on provided detections. Heat accumulates over time and is drawn as a semi-transparent overlay
src/supervision/annotators/core.py:2119
↓ 4 callersClassMeanAveragePrecisionResult
The result of the Mean Average Precision calculation. Defaults to `0` when no detections or targets are present. Attributes: me
src/supervision/metrics/mean_average_precision.py:30
↓ 4 callersClassVector
Represents a vector in 2D space, defined by a start and an end point. Attributes: start: The starting point of the vector. e
src/supervision/geometry/core.py:73
↓ 3 callersClassBackgroundOverlayAnnotator
A class for drawing a colored overlay on the background of an image outside the region of detections. If masks are provided, the backgro
src/supervision/annotators/core.py:2945
↓ 3 callersClassFPSBasedTimer
A timer that calculates the duration each object has been detected based on frames per second (FPS). Attributes: fps (float): Th
examples/time_in_zone/utils/timers.py:8
↓ 3 callersClassPolygonAnnotator
A class for drawing polygons on an image using provided detections. !!! warning This annotator uses `sv.Detections.mask`.
src/supervision/annotators/core.py:511
↓ 2 callersClassBoxCornerAnnotator
A class for drawing box corners on an image using provided detections.
src/supervision/annotators/core.py:899
↓ 2 callersClassCircleAnnotator
A class for drawing circle on an image using provided detections.
src/supervision/annotators/core.py:994
↓ 2 callersClassClassificationDataset
Contains information about a classification dataset, handles lazy image loading, dataset splitting. Attributes: classes: List co
src/supervision/dataset/core.py:727
↓ 2 callersClassClassifications
src/supervision/classification/core.py:33
↓ 2 callersClassColorAnnotator
A class for drawing box masks on an image using provided detections.
src/supervision/annotators/core.py:606
↓ 2 callersClassComparisonAnnotator
Highlights the differences between two sets of detections. Useful for comparing results from two different models, or the difference betw
src/supervision/annotators/core.py:3032
↓ 2 callersClassCropAnnotator
A class for drawing scaled up crops of detections on the scene.
src/supervision/annotators/core.py:2790
↓ 2 callersClassDotAnnotator
A class for drawing dots on an image at specific coordinates based on provided detections.
src/supervision/annotators/core.py:1086
↓ 2 callersClassEllipseAnnotator
A class for drawing ellipses on an image using provided detections.
src/supervision/annotators/core.py:800
↓ 2 callersClassF1ScoreResult
The results of the F1 score metric calculation. Defaults to `0` if no detections or targets were provided. Attributes: metric_t
src/supervision/metrics/f1_score.py:512
↓ 2 callersClassIdCounter
src/supervision/tracker/byte_tracker/utils.py:4
↓ 2 callersClassKalmanFilter
A simple Kalman filter for tracking bounding boxes in image space. The 8-dimensional state space is (x, y, a, h, vx, vy, va, vh), where
src/supervision/tracker/byte_tracker/kalman_filter.py:8
↓ 2 callersClassLabelAnnotator
A class for annotating labels on an image using provided detections.
src/supervision/annotators/core.py:1197
↓ 2 callersClassMeanAverageRecallResult
The results of the Mean Average Recall metric calculation. Defaults to `0` if no detections or targets were provided. Attributes:
src/supervision/metrics/mean_average_recall.py:31
↓ 2 callersClassOrientedBoxAnnotator
A class for drawing oriented bounding boxes on an image using provided detections.
src/supervision/annotators/core.py:277
↓ 2 callersClassPercentageBarAnnotator
A class for drawing percentage bars on an image using provided detections.
src/supervision/annotators/core.py:2583
↓ 2 callersClassPrecisionResult
The results of the precision metric calculation. Defaults to `0` if no detections or targets were provided. Attributes: metric_
src/supervision/metrics/precision.py:521
↓ 2 callersClassRecallResult
The results of the recall metric calculation. Defaults to `0` if no detections or targets were provided. Attributes: metric_tar
src/supervision/metrics/recall.py:479
↓ 2 callersClassRichLabelAnnotator
A class for annotating labels on an image using provided detections, with support for Unicode characters by using a custom font.
src/supervision/annotators/core.py:1512
↓ 2 callersClassRoundBoxAnnotator
A class for drawing bounding boxes with round edges on an image using provided detections.
src/supervision/annotators/core.py:2447
↓ 2 callersClassSTrack
src/supervision/tracker/byte_tracker/single_object_track.py:19
↓ 2 callersClassTriangleAnnotator
A class for drawing triangle markers on an image at specific coordinates based on provided detections.
src/supervision/annotators/core.py:2325
↓ 2 callersClass_FakeUltralyticsResults
Ultralytics-like results container used by from_ultralytics.
tests/helpers.py:287
↓ 2 callersClass_MockTensor
tests/classification/test_core.py:11
↓ 1 callersClassCOCOEvaluator
Evaluator class to compute COCO metrics.
src/supervision/metrics/mean_average_precision.py:584
↓ 1 callersClassCOCOEvaluatorParameters
Parameters for COCOEvaluator
src/supervision/metrics/mean_average_precision.py:546
↓ 1 callersClassColor
Represents a color in RGBA format. This class provides methods to work with colors, including creating colors from hex codes, converting
src/supervision/draw/color.py:66
↓ 1 callersClassCustomSink
examples/time_in_zone/inference_stream_example.py:17
↓ 1 callersClassCustomSink
examples/time_in_zone/ultralytics_stream_example.py:20
↓ 1 callersClassCustomSink
examples/time_in_zone/rfdetr_stream_example.py:79
↓ 1 callersClassDetectionsManager
examples/traffic_analysis/inference_example.py:31
↓ 1 callersClassDetectionsManager
examples/traffic_analysis/ultralytics_example.py:29
↓ 1 callersClassEvaluationDataset
Class used representing a dataset in the right format needed by the `COCOEvaluator` class.
src/supervision/metrics/mean_average_precision.py:249
↓ 1 callersClassLMM
Enum specifying supported Large Multimodal Models (LMMs). .. deprecated:: 0.27.0 `LMM` is deprecated and will be removed in `supervi
src/supervision/detection/vlm.py:22
↓ 1 callersClassLineZoneAnnotatorMulticlass
src/supervision/detection/line_zone.py:713
↓ 1 callersClassScenarioResult
examples/compact_mask/benchmark.py:73
↓ 1 callersClassTrace
src/supervision/annotators/utils.py:332
↓ 1 callersClassVLM
Enum specifying supported Vision-Language Models (VLMs). Attributes: PALIGEMMA: Google's PaliGemma vision-language model. FL
src/supervision/detection/vlm.py:73
↓ 1 callersClassVideoInfo
A class to store video information, including width, height, fps and total number of frames. Attributes: width: width of the
src/supervision/utils/video.py:26
↓ 1 callersClassVideoProcessor
examples/traffic_analysis/inference_example.py:75
↓ 1 callersClassVideoProcessor
examples/traffic_analysis/ultralytics_example.py:73
↓ 1 callersClassVideoSink
Context manager that saves video frames to a file using OpenCV. Attributes: target_path: The path to the output file where the video
src/supervision/utils/video.py:76
↓ 1 callersClassViewTransformer
examples/speed_estimation/inference_example.py:25
↓ 1 callersClassViewTransformer
examples/speed_estimation/ultralytics_example.py:24
↓ 1 callersClassViewTransformer
examples/speed_estimation/yolo_nas_example.py:25
↓ 1 callersClass_FakeSdkResult
tests/detection/test_core.py:986
↓ 1 callersClass_FakeUltralyticsBoxes
Ultralytics-like Boxes exposing xyxy/conf/cls and optional id.
tests/helpers.py:271
↓ 1 callersClass_FakeYOLOv5Results
YOLOv5-like results exposing pred list.
tests/helpers.py:264
↓ 1 callersClass_FakeYoloNasPrediction
YOLO-NAS-like prediction struct.
tests/helpers.py:301
↓ 1 callersClass_FakeYoloNasResults
YOLO-NAS-like results exposing prediction.
tests/helpers.py:310
ClassAssets
src/supervision/assets/list.py:7
ClassAveragingMethod
Defines different ways of averaging the metric results. Suppose, before returning the final result, a metric is computed for each class.
src/supervision/metrics/core.py:51
ClassBaseAnnotator
src/supervision/annotators/base.py:7
ClassBaseDataset
src/supervision/dataset/core.py:41
ClassBaseKeyPointAnnotator
src/supervision/key_points/annotators.py:24
ClassByteTrack
Initialize the ByteTrack object. .. deprecated:: 0.28.0 `ByteTrack` is deprecated since `supervision-0.28.0` and will be removed in
src/supervision/tracker/byte_tracker/core.py:22
ClassCSVSink
A utility class for saving detection data to a CSV file. This class is designed to efficiently serialize detection objects into a CSV format,
src/supervision/detection/tools/csv_sink.py:31
ClassColorLookup
Enumeration class to define strategies for mapping colors to annotations. This enum supports three different lookup strategies: - `I
src/supervision/annotators/utils.py:21
ClassColorPalette
src/supervision/draw/color.py:406
ClassConfusionMatrix
Confusion matrix for object detection tasks. Attributes: matrix: An 2D `np.ndarray` of shape `(len(classes) + 1, len(classes) + 1)`
src/supervision/metrics/detection.py:200
ClassEdgeAnnotator
A class that specializes in drawing skeleton edges on images using specified key points. It connects key points with lines to form the skelet
src/supervision/key_points/annotators.py:111
ClassFPSMonitor
A class for monitoring frames per second (FPS) to benchmark latency.
src/supervision/utils/video.py:459
ClassIconAnnotator
A class for drawing an icon on an image, using provided detections.
src/supervision/annotators/core.py:1788
ClassImageAssets
Each member of this enum represents a image asset. The value associated with each member is the filename of the image. | Asset
src/supervision/assets/list.py:57
ClassImageSink
src/supervision/utils/image.py:481
ClassJSONSink
A utility class for saving detection data to a JSON file. This class is designed to efficiently serialize detection objects into a JSON forma
src/supervision/detection/tools/json_sink.py:13
ClassLineZoneAnnotator
src/supervision/detection/line_zone.py:330
ClassMeanAveragePrecision
!!! deprecated "Deprecated" `MeanAveragePrecision` is **deprecated** and will be removed in `supervision-0.31.0`. The de
src/supervision/metrics/detection.py:756
ClassMetric
The base class for all supervision metrics.
src/supervision/metrics/core.py:8
ClassMetricTarget
Specifies what type of detection is used to compute the metric. Attributes: BOXES: xyxy bounding boxes MASKS: Binary masks
src/supervision/metrics/core.py:36
ClassMockClass
tests/utils/test_internal.py:12
ClassMockDataclass
tests/utils/test_internal.py:41
next →1–100 of 220, ranked by callers