Fix docstring for heatmaps_to_keypoints #9323
Merged
Conversation
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
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/vision/9323
Note: Links to docs will display an error until the docs builds have been completed. This comment was automatically generated by Dr. CI and updates every 15 minutes. |
zy1git
approved these changes
Jan 23, 2026
NicolasHug
approved these changes
Jan 23, 2026
Member
NicolasHug
left a comment
NicolasHug
left a comment
There was a problem hiding this comment.
Thanks for the PR @raimbekovm ! and @zy1git for the review!
Contributor
Author
|
Thank you for the review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Fixes #7148
The docstring for
heatmaps_to_keypointswas incorrect:(#rois, 4, #keypoints)but actual shape is(#rois, #keypoints, 3)(x, y, logit, prob)but actually contains(x, y, visibility)Changes
Updated docstring to follow Google style with accurate
ArgsandReturnssections that match the actual function behavior:xy_preds:Tensor[K, N, 3]containing(x, y, v)coordinates and visibilityscores:Tensor[K, N]containing heatmap scores at predicted locations