From df9057d716dcb71e55702540a7330c10649eb937 Mon Sep 17 00:00:00 2001 From: vfdev-5 Date: Fri, 24 Feb 2023 10:55:38 +0100 Subject: [PATCH 1/4] Updated _meta.py docstrings --- torchvision/transforms/v2/_meta.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/torchvision/transforms/v2/_meta.py b/torchvision/transforms/v2/_meta.py index 7d0f0ec39f9..16ea6d5a8ba 100644 --- a/torchvision/transforms/v2/_meta.py +++ b/torchvision/transforms/v2/_meta.py @@ -9,6 +9,14 @@ class ConvertBoundingBoxFormat(Transform): + """[BETA] Convert bounding box coordinates to the given ``format``, i.e. + from "CXCYWH" to "XYXY". + + .. betastatus:: ConvertBoundingBoxFormat transform + + Args: + format (str or datapoints.BoundingBoxFormat): output bounding box format. + """ _transformed_types = (datapoints.BoundingBox,) def __init__(self, format: Union[str, datapoints.BoundingBoxFormat]) -> None: @@ -22,7 +30,7 @@ def _transform(self, inpt: datapoints.BoundingBox, params: Dict[str, Any]) -> da class ConvertDtype(Transform): - """[BETA] Convert a tensor image/box/mask to the given ``dtype`` and scale the values accordingly + """[BETA] Convert input image or video to the given ``dtype`` and scale the values accordingly. .. betastatus:: ConvertDtype transform @@ -63,6 +71,12 @@ def _transform( class ClampBoundingBox(Transform): + """[BETA] Clamp bounding boxes coordinates between ``[0, spatial_size[0]]`` for x-axis and + ``[0, spatial_size[1]]`` for y-axis. + + .. betastatus:: ClampBoundingBox transform + + """ _transformed_types = (datapoints.BoundingBox,) def _transform(self, inpt: datapoints.BoundingBox, params: Dict[str, Any]) -> datapoints.BoundingBox: From 6b97305a3acd5ba9db4404e16b7f0f173c110ec8 Mon Sep 17 00:00:00 2001 From: vfdev Date: Fri, 24 Feb 2023 11:14:31 +0100 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Nicolas Hug --- torchvision/transforms/v2/_meta.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/torchvision/transforms/v2/_meta.py b/torchvision/transforms/v2/_meta.py index 16ea6d5a8ba..7570c6f8f5d 100644 --- a/torchvision/transforms/v2/_meta.py +++ b/torchvision/transforms/v2/_meta.py @@ -9,8 +9,7 @@ class ConvertBoundingBoxFormat(Transform): - """[BETA] Convert bounding box coordinates to the given ``format``, i.e. - from "CXCYWH" to "XYXY". + """[BETA] Convert bounding box coordinates to the given ``format``, e.g. from "CXCYWH" to "XYXY". .. betastatus:: ConvertBoundingBoxFormat transform @@ -71,8 +70,9 @@ def _transform( class ClampBoundingBox(Transform): - """[BETA] Clamp bounding boxes coordinates between ``[0, spatial_size[0]]`` for x-axis and - ``[0, spatial_size[1]]`` for y-axis. + """[BETA] Clamp bounding boxes to their corresponding image dimensions. + + The clamping is done according to the bounding boxes' ``spatial_size`` meta-data. .. betastatus:: ClampBoundingBox transform From eb269d41b463975d9b51853731628747614736f1 Mon Sep 17 00:00:00 2001 From: vfdev-5 Date: Fri, 24 Feb 2023 11:22:57 +0100 Subject: [PATCH 3/4] Updated transforms.rst --- docs/source/transforms.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/transforms.rst b/docs/source/transforms.rst index 1dec6bedf15..8e3c60085de 100644 --- a/docs/source/transforms.rst +++ b/docs/source/transforms.rst @@ -191,6 +191,7 @@ Miscellaneous Lambda v2.Lambda v2.SanitizeBoundingBox + v2.ClampBoundingBox .. _conversion_transforms: @@ -212,6 +213,7 @@ Conversion v2.ConvertImageDtype v2.ConvertDtype v2.ToDtype + v2.ConvertBoundingBoxFormat Auto-Augmentation ----------------- From 1a710451e585d9796dce4751487aea69dd000f33 Mon Sep 17 00:00:00 2001 From: vfdev-5 Date: Fri, 24 Feb 2023 11:59:18 +0100 Subject: [PATCH 4/4] Updated format possible values --- torchvision/transforms/v2/_meta.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/torchvision/transforms/v2/_meta.py b/torchvision/transforms/v2/_meta.py index 7570c6f8f5d..94ec851d045 100644 --- a/torchvision/transforms/v2/_meta.py +++ b/torchvision/transforms/v2/_meta.py @@ -15,6 +15,8 @@ class ConvertBoundingBoxFormat(Transform): Args: format (str or datapoints.BoundingBoxFormat): output bounding box format. + Possible values are defined by :class:`~torchvision.datapoints.BoundingBoxFormat` and + string values match the enums, e.g. "XYXY" or "XYWH" etc. """ _transformed_types = (datapoints.BoundingBox,) @@ -71,7 +73,7 @@ def _transform( class ClampBoundingBox(Transform): """[BETA] Clamp bounding boxes to their corresponding image dimensions. - + The clamping is done according to the bounding boxes' ``spatial_size`` meta-data. .. betastatus:: ClampBoundingBox transform