Skip to content

Commit 38079bd

Browse files
committed
Fix docstring: remove double periods and incorrect 'padding_mode' reference
1 parent f52c4f1 commit 38079bd

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

torchvision/transforms/v2/_geometry.py

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ class Pad(Transform):
434434
.. note::
435435
In torchscript mode padding as single int is not supported, use a sequence of
436436
length 1: ``[padding, ]``.
437-
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
437+
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
438438
Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
439439
Fill value can be also a dictionary mapping data type to the fill value, e.g.
440440
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
@@ -509,7 +509,7 @@ class RandomZoomOut(_RandomApplyTransform):
509509
the image can have ``[..., C, H, W]`` shape. A bounding box can have ``[..., 4]`` shape.
510510
511511
Args:
512-
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
512+
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
513513
Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
514514
Fill value can be also a dictionary mapping data type to the fill value, e.g.
515515
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
@@ -586,7 +586,7 @@ class RandomRotation(Transform):
586586
center of rotation. In practice however, due to numerical precision, this can lead to off-by-one
587587
differences of the resulting image size compared to using the image center in the first place. Thus, when
588588
setting ``expand=True``, it's best to leave ``center=None`` (default).
589-
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
589+
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
590590
Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
591591
Fill value can be also a dictionary mapping data type to the fill value, e.g.
592592
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
@@ -664,7 +664,7 @@ class RandomAffine(Transform):
664664
:class:`torchvision.transforms.InterpolationMode`. Default is ``InterpolationMode.NEAREST``.
665665
If input is Tensor, only ``InterpolationMode.NEAREST``, ``InterpolationMode.BILINEAR`` are supported.
666666
The corresponding Pillow integer constants, e.g. ``PIL.Image.BILINEAR`` are accepted as well.
667-
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
667+
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
668668
Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
669669
Fill value can be also a dictionary mapping data type to the fill value, e.g.
670670
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
@@ -780,7 +780,8 @@ class RandomCrop(Transform):
780780
pad_if_needed (boolean, optional): It will pad the image if smaller than the
781781
desired size to avoid raising an exception. Since cropping is done
782782
after padding, the padding seems to be done at a random offset.
783-
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
783+
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
784+
784785
Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
785786
Fill value can be also a dictionary mapping data type to the fill value, e.g.
786787
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
@@ -927,7 +928,7 @@ class RandomPerspective(_RandomApplyTransform):
927928
:class:`torchvision.transforms.InterpolationMode`. Default is ``InterpolationMode.BILINEAR``.
928929
If input is Tensor, only ``InterpolationMode.NEAREST``, ``InterpolationMode.BILINEAR`` are supported.
929930
The corresponding Pillow integer constants, e.g. ``PIL.Image.BILINEAR`` are accepted as well.
930-
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
931+
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
931932
Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
932933
Fill value can be also a dictionary mapping data type to the fill value, e.g.
933934
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
@@ -1028,7 +1029,7 @@ class ElasticTransform(Transform):
10281029
:class:`torchvision.transforms.InterpolationMode`. Default is ``InterpolationMode.BILINEAR``.
10291030
If input is Tensor, only ``InterpolationMode.NEAREST``, ``InterpolationMode.BILINEAR`` are supported.
10301031
The corresponding Pillow integer constants, e.g. ``PIL.Image.BILINEAR`` are accepted as well.
1031-
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
1032+
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
10321033
Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
10331034
Fill value can be also a dictionary mapping data type to the fill value, e.g.
10341035
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and

0 commit comments

Comments
 (0)