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.
sv.ByteTrackis deprecated insupervision-0.28.0in favour ofByteTrackTrackerfrom the externaltrackerspackage (pip install trackers). The update method is renamed fromupdate_with_detections()toupdate(). Removal is planned forsupervision-0.31.0.supervision.keypointmodule is deprecated insupervision-0.27.0; usesupervision.key_pointsinstead. It will be removed insupervision-0.31.0.create_tilesinsupervision.utils.imageis deprecated insupervision-0.27.0. It will be removed insupervision-0.31.0.ensure_cv2_image_for_processinginsupervision.utils.conversionis deprecated insupervision-0.27.0. It will be removed insupervision-0.31.0.- Keypoint validation utilities in
supervision.validatorsare deprecated insupervision-0.27.0. They will be removed insupervision-0.31.0. normalized_xyxyargument insv.denormalize_boxesis deprecated insupervision-0.27.0and renamed toxyxy. Passingnormalized_xyxy=emits aFutureWarning; support will be removed insupervision-0.31.0.supervision.dataset.utilsimport path forsv.rle_to_maskandsv.mask_to_rleis deprecated insupervision-0.28.0. These functions moved tosupervision.detection.utils.convertersand will be removed fromsupervision.dataset.utilsinsupervision-0.31.0.sv.LMMenum is deprecated insupervision-0.27.0and will be removed insupervision-0.31.0. Usesv.VLMinstead.sv.Detections.from_lmmclassmethod is deprecated insupervision-0.26.0and will be removed insupervision-0.31.0. Usesv.Detections.from_vlminstead.KeyPoints.confidenceis deprecated insupervision-0.29.0. UseKeyPoints.keypoint_confidenceinstead. It will be removed insupervision-0.32.0.- Public
validate_*helper functions are deprecated insupervision-0.29.0and will be removed insupervision-0.32.0. Supervision internals now use private_validate_*helpers.
Removed¶
0.27.0¶
overlap_ratio_whparameter insv.InferenceSlicerhas been removed. Use the pixel-basedoverlap_whparameter instead.overlap_filter_strategyparameter insv.InferenceSlicerhas been removed. Useoverlap_strategyinstead.
0.26.0¶
- The
sv.DetectionDataset.imagesproperty has been removed insupervision-0.26.0. Please loop over images withfor path, image, annotation in dataset:, as that does not require loading all images into memory. Also, constructingsv.DetectionDatasetwith parameterimagesasDict[str, np.ndarray]is deprecated and has been removed insupervision-0.26.0. Please pass a list of pathsList[str]instead. - The name
sv.BoundingBoxAnnotatoris deprecated and has been removed insupervision-0.26.0. It has been renamed tosv.BoxAnnotator.
0.24.0¶
- The
frame_resolution_whparameter insv.PolygonZonehas 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, andmatch_threshparameters inByteTrackare deprecated and were removed as ofsupervision-0.23.0. Uselost_track_buffer,track_activation_threshold, andminimum_matching_thresholdinstead. - The
triggering_positionparameter insv.PolygonZonewas removed as ofsupervision-0.23.0. Usetriggering_anchorsinstead.
0.22.0¶
sv.Detections.from_roboflowis removed as ofsupervision-0.22.0. UseDetections.from_inferenceinstead.- The method
sv.Color.white()was removed as ofsupervision-0.22.0. Use the constantsv.Color.WHITEinstead. - The method
sv.Color.black()was removed as ofsupervision-0.22.0. Use the constantsv.Color.BLACKinstead. - The method
sv.Color.red()was removed as ofsupervision-0.22.0. Use the constantsv.Color.REDinstead. - The method
sv.Color.green()was removed as ofsupervision-0.22.0. Use the constantsv.Color.GREENinstead. - The method
sv.Color.blue()was removed as ofsupervision-0.22.0. Use the constantsv.Color.BLUEinstead. - The method
sv.ColorPalette.default()was removed as ofsupervision-0.22.0. Use the constantColorPalette.DEFAULTinstead. sv.BoxAnnotatorwas removed as ofsupervision-0.22.0, howeversv.BoundingBoxAnnotatorwas immediately renamed tosv.BoxAnnotator. UseBoxAnnotatorandLabelAnnotatorinstead of the oldsv.BoxAnnotator.- The method
sv.FPSMonitor.__call__was removed as ofsupervision-0.22.0. Use the attributesv.FPSMonitor.fpsinstead.