Unverified Commit 11e49de4 authored by Nicolas Hug's avatar Nicolas Hug Committed by GitHub
Browse files

clarifying docs for v2.ToPILImage() (#7864)

parent 26ed129d
...@@ -44,23 +44,24 @@ class ToImage(Transform): ...@@ -44,23 +44,24 @@ class ToImage(Transform):
class ToPILImage(Transform): class ToPILImage(Transform):
"""[BETA] Convert a tensor or an ndarray to PIL Image - this does not scale values. """[BETA] Convert a tensor or an ndarray to PIL Image
.. v2betastatus:: ToPILImage transform .. v2betastatus:: ToPILImage transform
This transform does not support torchscript. This transform does not support torchscript.
Converts a torch.*Tensor of shape C x H x W or a numpy ndarray of shape Converts a torch.*Tensor of shape C x H x W or a numpy ndarray of shape
H x W x C to a PIL Image while preserving the value range. H x W x C to a PIL Image while adjusting the value range depending on the ``mode``.
Args: Args:
mode (`PIL.Image mode`_): color space and pixel depth of input data (optional). mode (`PIL.Image mode`_): color space and pixel depth of input data (optional).
If ``mode`` is ``None`` (default) there are some assumptions made about the input data: If ``mode`` is ``None`` (default) there are some assumptions made about the input data:
- If the input has 4 channels, the ``mode`` is assumed to be ``RGBA``. - If the input has 4 channels, the ``mode`` is assumed to be ``RGBA``.
- If the input has 3 channels, the ``mode`` is assumed to be ``RGB``. - If the input has 3 channels, the ``mode`` is assumed to be ``RGB``.
- If the input has 2 channels, the ``mode`` is assumed to be ``LA``. - If the input has 2 channels, the ``mode`` is assumed to be ``LA``.
- If the input has 1 channel, the ``mode`` is determined by the data type (i.e ``int``, ``float``, - If the input has 1 channel, the ``mode`` is determined by the data type (i.e ``int``, ``float``,
``short``). ``short``).
.. _PIL.Image mode: https://pillow.readthedocs.io/en/latest/handbook/concepts.html#concept-modes .. _PIL.Image mode: https://pillow.readthedocs.io/en/latest/handbook/concepts.html#concept-modes
""" """
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment