docs: link "Memory-Efficient Instance Segmentation" notebook and update deprecations#2241
Merged
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #2241 +/- ##
=======================================
Coverage 78% 78%
=======================================
Files 66 66
Lines 8347 8347
=======================================
Hits 6475 6475
Misses 1872 1872 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Supervision’s documentation to improve notebook discoverability and to reflect recent API deprecations/removals, plus minor changelog link corrections.
Changes:
- Added a new cookbook card linking to the “Memory-Efficient Instance Segmentation” notebook.
- Updated
docs/deprecated.mdwith new deprecations and a new “Removed (0.27.0)” section forInferenceSlicerparameter removals. - Updated changelog links for
sv.CompactMaskdocs from/develop/to/latest/and cleaned notebook heading / outputs.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/theme/cookbooks.html | Adds a new cookbook card entry for the compact-mask/SAM3 notebook. |
| docs/notebooks/compact-mask-sam3.ipynb | Removes version from the title and clears verbose cell output for a cleaner rendered notebook. |
| docs/deprecated.md | Expands deprecation/removal notices with timelines and migration pointers. |
| docs/changelog.md | Fixes sv.CompactMask doc URLs to point at /latest/ instead of /develop/. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates documentation and the changelog to reflect recent deprecations, removals, and improvements in the
supervisionlibrary, as well as enhances the clarity and navigation of example notebooks. The most significant changes include a comprehensive update to the deprecation and removal notices, improvements to the changelog URLs for better accuracy, and the addition of a new memory-efficient instance segmentation notebook to the cookbooks section.Deprecations and Removals:
docs/deprecated.mdwith several new deprecations, including the deprecation ofsv.ByteTrack(in favor of an external package), thesupervision.keypointmodule,create_tiles,ensure_cv2_image_for_processing, keypoint validation utilities, and changes to argument names and import paths for several functions. Also, added explicit removal notices foroverlap_ratio_whandoverlap_filter_strategyparameters insv.InferenceSlicer.Changelog Improvements:
docs/changelog.mdforsv.CompactMaskandsv.CompactMask.resizeto point to the latest documentation instead of the develop branch, improving link accuracy and user experience.Notebook and Documentation Enhancements:
docs/theme/cookbooks.htmlfor easier discovery.docs/notebooks/compact-mask-sam3.ipynbnotebook by removing version-specific headings and suppressing verbose cell outputs, making the notebook more concise and user-friendly. [1] [2] [3]