Skip to content

docs: Fix outdated doc files per issue #1920 #1995

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

docs: Fix outdated doc files per issue #1920 #1995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4bbf040
docs: Fix outdated doc files per issue #1920
MKSubrahmanya12345 Oct 21, 2025
eec6c29
fix(pre_commit): 🎨 auto format pre-commit hooks
pre-commit-ci[bot] Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/deprecated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@ status: deprecated

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

- `overlap_ratio_wh` in [`InferenceSlicer.__init__`](https://supervision.roboflow.com/latest/detection/tools/inference_slicer/) is deprecated and will be removed in `supervision-0.27.0`. Please set it to `None` and use `overlap_wh` instead.

- `overlap_filter_strategy` in [`InferenceSlicer.__init__`](https://supervision.roboflow.com/latest/detection/tools/inference_slicer/) is deprecated and will be removed in `supervision-0.27.0`. Use `overlap_strategy` instead.
- `overlap_ratio_wh` in [`InferenceSlicer.__init__`](https://supervision.roboflow.com/latest/detection/tools/inference_slicer/) is deprecated and will be removed in `supervision-0.27.0`. Use `overlap_wh` instead.
- `sv.LMM` enum is deprecated and will be removed in `supervision-0.31.0`. Use `sv.VLM` instead.
- [`sv.Detections.from_lmm`](https://supervision.roboflow.com/0.26.0/detection/core/#supervision.detection.core.Detections.from_lmm) property is deprecated and will be removed in `supervision-0.31.0`. Use [`sv.Detections.from_vlm`](https://supervision.roboflow.com/0.26.0/detection/core/#supervision.detection.core.Detections.from_vlm) instead.
- [`sv.Detections.from_lmm`](https://supervision.roboflow.com/0.26.0/detection/core/#supervision.detection.core.Detections.from_lmm) property is deprecated and will be removed in `supervision-0.31.0`. Use `sv.Detections.from_vlm` instead.

# Removed

Expand Down
14 changes: 13 additions & 1 deletion docs/detection/utils/boxes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ status: new
:::supervision.detection.utils.boxes.scale_boxes

<div class="md-typeset">
<h2><a href="#supervision.detection.boxes.utils.clip_boxes">clip_boxes</a></h2>
<h2><a href="#supervision.detection.utils.boxes.clip_boxes">clip_boxes</a></h2>
</div>

:::supervision.detection.utils.boxes.clip_boxes
Expand All @@ -34,3 +34,15 @@ status: new
</div>

:::supervision.detection.utils.boxes.denormalize_boxes

<div class="md-typeset">
<h2><a href="#supervision.detection.utils.boxes.move_oriented_boxes">move_oriented_boxes</a></h2>
</div>

:::supervision.detection.utils.boxes.move_oriented_boxes

<div class="md-typeset">
<h2><a href="#supervision.detection.utils.boxes.spread_out_boxes">spread_out_boxes</a></h2>
</div>

:::supervision.detection.utils.boxes.spread_out_boxes
12 changes: 12 additions & 0 deletions docs/detection/utils/masks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,15 @@ status: new
</div>

:::supervision.detection.utils.masks.contains_multiple_segments

<div class="md-typeset">
<h2><a href="#supervision.detection.utils.masks.calculate_masks_centroids">calculate_masks_centroids</a></h2>
</div>

:::supervision.detection.utils.masks.calculate_masks_centroids

<div class="md-typeset">
<h2><a href="#supervision.detection.utils.masks.resize_masks">resize_masks</a></h2>
</div>

:::supervision.detection.utils.masks.resize_masks