Updates to RoI transforms docs #3645
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
fmassa
requested changes
Apr 8, 2021
torchvision/ops/ps_roi_align.py
Outdated
| @@ -19,23 +19,26 @@ def ps_roi_align( | |||
| mentioned in Light-Head R-CNN. | |||
|
|
|||
| Args: | |||
| input (Tensor[N, C, H, W]): input tensor | |||
| input (Tensor[N, C, H, W]): The input tensor, i.e. a batch with ``N`` feature maps | |||
There was a problem hiding this comment.
This is actually not correct -- N is the batch size, C is the number of feature maps (aka channels)
torchvision/ops/ps_roi_align.py
Outdated
| output_size (int or Tuple[int, int]): the size of the output after the cropping | ||
| is performed, as (height, width) | ||
| If a single Tensor is passed, then the first column should | ||
| contain the index of the corresponding feature map in the batch, i.e. a number in ``[0, N - 1]``. |
There was a problem hiding this comment.
index of the corresponding element in the batch. I think calling it feature map might be more more confusing
There was a problem hiding this comment.
ah thanks, I was assuming a feature map was C x H x W for some reason
facebook-github-bot
pushed a commit
that referenced
this pull request
May 4, 2021
Summary: * Edited roi transforms docs * remove incorrect param desc * Fixed confusion about feature maps according to comment Reviewed By: NicolasHug Differential Revision: D28169142 fbshipit-source-id: ee6abdf6d80b7ba53104aece3abc058ceb35c469
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 PR adds some minor edits to the docstrings of the RoI transforms, in particular about the feature map indices in the RoIs tensor which were previously a source of confusion to me