Skip to content

Conversation

@raimbekovm
Copy link
Contributor

Summary

Fixes #7148

The docstring for heatmaps_to_keypoints was incorrect:

  • Stated output shape as (#rois, 4, #keypoints) but actual shape is (#rois, #keypoints, 3)
  • Stated last dimension contains (x, y, logit, prob) but actually contains (x, y, visibility)
  • Did not mention that the function returns a tuple of two tensors

Changes

Updated docstring to follow Google style with accurate Args and Returns sections that match the actual function behavior:

  • xy_preds: Tensor[K, N, 3] containing (x, y, v) coordinates and visibility
  • scores: Tensor[K, N] containing heatmap scores at predicted locations

@pytorch-bot
Copy link

pytorch-bot bot commented Jan 1, 2026

🔗 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.

✅ No Failures

As of commit e630850 with merge base 1e53952 (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@meta-cla meta-cla bot added the cla signed label Jan 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docstring for heatmaps_to_keypoints does not match return values.

2 participants