Skip to content

Deprecated

These features are phased out due to better alternatives or potential issues in future versions. Deprecated functionalities are typically supported for multiple subsequent releases, providing time for users to transition to updated methods.

  • KeyPoints.confidence is deprecated in supervision-0.29.0. Use KeyPoints.keypoint_confidence instead. It will be removed in supervision-0.32.0.
  • Public validate_* helper functions are deprecated in supervision-0.29.0 and will be removed in supervision-0.32.0. Supervision internals now use private _validate_* helpers.
  • merge_inner_detection_object_pair, merge_inner_detections_objects, and merge_inner_detections_objects_without_iou in supervision.detection.core are deprecated in supervision-0.29.0 and will be removed in supervision-0.32.0.
  • Passing overlap_metric or mask_dimension positionally to sv.mask_non_max_merge is deprecated in supervision-0.30.0 and will be removed in supervision-0.33.0. Pass both by keyword instead.

Removed

0.31.0

  • sv.ByteTrack was removed as of supervision-0.31.0. Use ByteTrackTracker from the external trackers package (pip install trackers) instead; its update method is update(), not update_with_detections().
  • The supervision.keypoint module was removed as of supervision-0.31.0. Import from supervision.key_points instead.
  • create_tiles in supervision.utils.image was removed as of supervision-0.31.0.
  • overlay_image in supervision.utils.image was removed as of supervision-0.31.0.
  • ensure_cv2_image_for_annotation, ensure_pil_image_for_annotation, and ensure_cv2_image_for_processing in supervision.utils.conversion were removed as of supervision-0.31.0.
  • The keypoint validation utilities validate_keypoint_confidence and validate_keypoints_fields in supervision.validators were removed as of supervision-0.31.0.
  • The normalized_xyxy argument of sv.denormalize_boxes was removed as of supervision-0.31.0. Use xyxy instead.
  • The supervision.dataset.utils import path for sv.rle_to_mask and sv.mask_to_rle was removed as of supervision-0.31.0. Import from supervision.detection.utils.converters (or top-level sv.rle_to_mask/sv.mask_to_rle) instead.
  • sv.LMM was removed as of supervision-0.31.0. Use sv.VLM instead.
  • sv.Detections.from_lmm was removed as of supervision-0.31.0. Use sv.Detections.from_vlm instead.
  • The legacy MeanAveragePrecision class in supervision.metrics.detection was removed as of supervision-0.31.0. Use supervision.metrics.mean_average_precision.MeanAveragePrecision (sv.metrics.MeanAveragePrecision) instead, which matches pycocotools.

0.27.0

  • overlap_ratio_wh parameter in sv.InferenceSlicer has been removed. Use the pixel-based overlap_wh parameter instead.
  • overlap_filter_strategy parameter in sv.InferenceSlicer has been removed. Use overlap_strategy instead.

0.26.0

  • The sv.DetectionDataset.images property has been removed in supervision-0.26.0. Please loop over images with for path, image, annotation in dataset:, as that does not require loading all images into memory. Also, constructing sv.DetectionDataset with parameter images as Dict[str, np.ndarray] is deprecated and has been removed in supervision-0.26.0. Please pass a list of paths List[str] instead.
  • The name sv.BoundingBoxAnnotator is deprecated and has been removed in supervision-0.26.0. It has been renamed to sv.BoxAnnotator.

0.24.0

  • The frame_resolution_wh parameter in sv.PolygonZone has been removed.
  • Supervision installation methods "headless" and "desktop" were removed, as they are no longer needed. pip install supervision[headless] will install the base library and harmlessly warn of non-existent extras.

0.23.0

  • The track_buffer, track_thresh, and match_thresh parameters in ByteTrack are deprecated and were removed as of supervision-0.23.0. Use lost_track_buffer, track_activation_threshold, and minimum_matching_threshold instead.
  • The triggering_position parameter in sv.PolygonZone was removed as of supervision-0.23.0. Use triggering_anchors instead.

0.22.0

  • sv.Detections.from_roboflow is removed as of supervision-0.22.0. Use Detections.from_inference instead.
  • The method sv.Color.white() was removed as of supervision-0.22.0. Use the constant sv.Color.WHITE instead.
  • The method sv.Color.black() was removed as of supervision-0.22.0. Use the constant sv.Color.BLACK instead.
  • The method sv.Color.red() was removed as of supervision-0.22.0. Use the constant sv.Color.RED instead.
  • The method sv.Color.green() was removed as of supervision-0.22.0. Use the constant sv.Color.GREEN instead.
  • The method sv.Color.blue() was removed as of supervision-0.22.0. Use the constant sv.Color.BLUE instead.
  • The method sv.ColorPalette.default() was removed as of supervision-0.22.0. Use the constant ColorPalette.DEFAULT instead.
  • sv.BoxAnnotator was removed as of supervision-0.22.0, however sv.BoundingBoxAnnotator was immediately renamed to sv.BoxAnnotator. Use BoxAnnotator and LabelAnnotator instead of the old sv.BoxAnnotator.
  • The method sv.FPSMonitor.__call__ was removed as of supervision-0.22.0. Use the attribute sv.FPSMonitor.fps instead.

Comments