Skip to content

Fix docstring for 'fill' in transforms without 'padding_mode' #9171

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Fix docstring for 'fill' in transforms without 'padding_mode' #9171

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0fca078
Fix docstring: remove double periods and incorrect 'padding_mode' ref…
abhitorch81 Aug 7, 2025
e40c4d9
Merge branch 'main' into fix-docstring-fill-param
abhitorch81 Aug 7, 2025
316cd17
Merge branch 'main' into fix-docstring-fill-param
abhitorch81 Aug 14, 2025
4bffd1e
Merge branch 'main' into fix-docstring-fill-param
abhitorch81 Aug 19, 2025
e8571e3
Merge branch 'main' into fix-docstring-fill-param
abhitorch81 Sep 2, 2025
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
15 changes: 8 additions & 7 deletions torchvision/transforms/v2/_geometry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ class Pad(Transform):
.. note::
In torchscript mode padding as single int is not supported, use a sequence of
length 1: ``[padding, ]``.
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
Fill value can be also a dictionary mapping data type to the fill value, e.g.
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
Expand Down Expand Up @@ -509,7 +509,7 @@ class RandomZoomOut(_RandomApplyTransform):
the image can have ``[..., C, H, W]`` shape. A bounding box can have ``[..., 4]`` shape.

Args:
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
Fill value can be also a dictionary mapping data type to the fill value, e.g.
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
Expand Down Expand Up @@ -586,7 +586,7 @@ class RandomRotation(Transform):
center of rotation. In practice however, due to numerical precision, this can lead to off-by-one
differences of the resulting image size compared to using the image center in the first place. Thus, when
setting ``expand=True``, it's best to leave ``center=None`` (default).
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
Fill value can be also a dictionary mapping data type to the fill value, e.g.
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
Expand Down Expand Up @@ -664,7 +664,7 @@ class RandomAffine(Transform):
:class:`torchvision.transforms.InterpolationMode`. Default is ``InterpolationMode.NEAREST``.
If input is Tensor, only ``InterpolationMode.NEAREST``, ``InterpolationMode.BILINEAR`` are supported.
The corresponding Pillow integer constants, e.g. ``PIL.Image.BILINEAR`` are accepted as well.
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The indentation here is wrong, which is causing the docs builds to fail. I think it's just a missing space.

Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
Fill value can be also a dictionary mapping data type to the fill value, e.g.
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
Expand Down Expand Up @@ -780,7 +780,8 @@ class RandomCrop(Transform):
pad_if_needed (boolean, optional): It will pad the image if smaller than the
desired size to avoid raising an exception. Since cropping is done
after padding, the padding seems to be done at a random offset.
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.

Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
Fill value can be also a dictionary mapping data type to the fill value, e.g.
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
Expand Down Expand Up @@ -927,7 +928,7 @@ class RandomPerspective(_RandomApplyTransform):
:class:`torchvision.transforms.InterpolationMode`. Default is ``InterpolationMode.BILINEAR``.
If input is Tensor, only ``InterpolationMode.NEAREST``, ``InterpolationMode.BILINEAR`` are supported.
The corresponding Pillow integer constants, e.g. ``PIL.Image.BILINEAR`` are accepted as well.
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
Fill value can be also a dictionary mapping data type to the fill value, e.g.
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
Expand Down Expand Up @@ -1028,7 +1029,7 @@ class ElasticTransform(Transform):
:class:`torchvision.transforms.InterpolationMode`. Default is ``InterpolationMode.BILINEAR``.
If input is Tensor, only ``InterpolationMode.NEAREST``, ``InterpolationMode.BILINEAR`` are supported.
The corresponding Pillow integer constants, e.g. ``PIL.Image.BILINEAR`` are accepted as well.
fill (number or tuple or dict, optional): Pixel fill value used when the ``padding_mode`` is constant.
fill (number or tuple or dict, optional): Pixel fill value used for pixels outside the image boundary.
Default is 0. If a tuple of length 3, it is used to fill R, G, B channels respectively.
Fill value can be also a dictionary mapping data type to the fill value, e.g.
``fill={tv_tensors.Image: 127, tv_tensors.Mask: 0}`` where ``Image`` will be filled with 127 and
Expand Down
Loading