Clarify scaling of ToTensor transform for target masks in the documen…

…tation (#2507) * Clarify scaling of ToTensor transform for target masks in the documentation * Add link to the segmentation reference Co-authored-by: vfdev <vfdev.5@gmail.com> Co-authored-by: vfdev <vfdev.5@gmail.com>
pytorch · Aug 3, 2020 · 7fc47ea · 7fc47ea
1 parent 62e3fbd
commit 7fc47ea
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/torchvision/transforms/transforms.py b/torchvision/transforms/transforms.py
@@ -72,6 +72,12 @@ class ToTensor(object):
     or if the numpy.ndarray has dtype = np.uint8
 
     In the other cases, tensors are returned without scaling.
+
+    .. note::
+        Because the input image is scaled to [0.0, 1.0], this transformation should not be used when
+        transforming target image masks. See the `references`_ for implementing the transforms for image masks.
+
+    .. _references: https://github.com/pytorch/vision/tree/master/references/segmentation
     """
 
     def __call__(self, pic):