Docstring Fix for PILToTensor in Torchvision #9254
Merged
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:
#9221 identifies a confusion around image shape conventions for ToTensor and PILToTensor classes. The docstring has the following statement:
Converts a PIL Image (H x W x C) to a Tensor of shape (C x H x W).
This is confusing since PIL Image shape is not (H x W x C) but rather PIL Images expose their size as (W, H) via the size attribute, not as a shape tuple.
Proposed Docstring Update
Convert a PIL Image with H height, W width, and C channels to a Tensor of shape (C x H x W).
Differential Revision: D85779518