Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update en docs of to_tensor #29718

Merged
merged 3 commits into from
Dec 17, 2020
Merged

Update en docs of to_tensor #29718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77b6b2f
update to_tensor en docs
LielinJiang Dec 17, 2020
f0a8bcd
update docs
LielinJiang Dec 17, 2020
5237a17
update docs
LielinJiang Dec 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions python/paddle/vision/transforms/functional.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@ def to_tensor(pic, data_format='CHW'):

Args:
pic (PIL.Image|np.ndarray): Image to be converted to tensor.
data_format (str, optional): Data format of input img, should be 'HWC' or
data_format (str, optional): Data format of output tensor, should be 'HWC' or
'CHW'. Default: 'CHW'.

Returns:
Tensor: Converted image. Data format is same as input img.
Tensor: Converted image. Data type is same as input img.

Examples:
.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion python/paddle/vision/transforms/functional_cv2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def to_tensor(pic, data_format='CHW'):

Args:
pic (np.ndarray): Image to be converted to tensor.
data_format (str, optional): Data format of img, should be 'HWC' or
data_format (str, optional): Data format of output tensor, should be 'HWC' or
'CHW'. Default: 'CHW'.

Returns:
Expand Down
2 changes: 1 addition & 1 deletion python/paddle/vision/transforms/functional_pil.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def to_tensor(pic, data_format='CHW'):

Args:
pic (PIL.Image): Image to be converted to tensor.
data_format (str, optional): Data format of img, should be 'HWC' or
data_format (str, optional): Data format of output tensor, should be 'HWC' or
'CHW'. Default: 'CHW'.

Returns:
Expand Down
16 changes: 11 additions & 5 deletions python/paddle/vision/transforms/transforms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,15 +296,21 @@ def _apply_mask(self, mask):
class ToTensor(BaseTransform):
"""Convert a ``PIL.Image`` or ``numpy.ndarray`` to ``paddle.Tensor``.

Converts a PIL.Image or numpy.ndarray (H x W x C) in the range
[0, 255] to a paddle.Tensor of shape (C x H x W) in the range [0.0, 1.0]
if the PIL Image belongs to one of the modes (L, LA, P, I, F, RGB, YCbCr, RGBA, CMYK, 1)
or if the numpy.ndarray has dtype = np.uint8
Converts a PIL.Image or numpy.ndarray (H x W x C) to a paddle.Tensor of shape (C x H x W).

If input is a grayscale image (H x W), it will be converted to a image of shape (H x W x 1).
And the shape of output tensor will be (1 x H x W).

If you want to keep the shape of output tensor as (H x W x C), you can set data_format = ``HWC`` .

Converts a PIL.Image or numpy.ndarray in the range [0, 255] to a paddle.Tensor in the
range [0.0, 1.0] if the PIL Image belongs to one of the modes (L, LA, P, I, F, RGB, YCbCr,
RGBA, CMYK, 1) or if the numpy.ndarray has dtype = np.uint8.

In the other cases, tensors are returned without scaling.

Args:
data_format (str, optional): Data format of input img, should be 'HWC' or
data_format (str, optional): Data format of output tensor, should be 'HWC' or
'CHW'. Default: 'CHW'.
keys (list[str]|tuple[str], optional): Same as ``BaseTransform``. Default: None.

Expand Down