Unverified Commit 9040793b authored by Nicolas Hug's avatar Nicolas Hug Committed by GitHub
Browse files

Minor doc update (#7836)

parent 4cba51c5
...@@ -15,14 +15,15 @@ if _WARN_ABOUT_BETA_TRANSFORMS: ...@@ -15,14 +15,15 @@ if _WARN_ABOUT_BETA_TRANSFORMS:
def wrap(wrappee, *, like, **kwargs): def wrap(wrappee, *, like, **kwargs):
"""Convert a :class:`torch.Tensor` (``wrappee``) into the same :class:`~torchvision.datapoint.Datapoint` subclass as ``like``. """[BETA] Convert a :class:`torch.Tensor` (``wrappee``) into the same :class:`~torchvision.datapoints.Datapoint` subclass as ``like``.
If ``like`` is a :class:`~torchvision.datapoint.BoundingBoxes`, the ``format`` and ``canvas_size`` of If ``like`` is a :class:`~torchvision.datapoints.BoundingBoxes`, the ``format`` and ``canvas_size`` of
``like`` are assigned to ``wrappee``, unless they are passed as ``kwargs``. ``like`` are assigned to ``wrappee``, unless they are passed as ``kwargs``.
Args: Args:
wrappee (Tensor): The tensor to convert. wrappee (Tensor): The tensor to convert.
like (Datapoint): The like (:class:`~torchvision.datapoints.Datapoint`): The reference.
``wrappee`` will be converted into the same subclass as ``like``.
kwargs: Can contain "format" and "canvas_size" if ``like`` is a :class:`~torchvision.datapoint.BoundingBoxes`. kwargs: Can contain "format" and "canvas_size" if ``like`` is a :class:`~torchvision.datapoint.BoundingBoxes`.
Ignored otherwise. Ignored otherwise.
""" """
......
...@@ -16,7 +16,7 @@ class _ReturnTypeCM: ...@@ -16,7 +16,7 @@ class _ReturnTypeCM:
def set_return_type(return_type: str): def set_return_type(return_type: str):
"""Set the return type of torch operations on datapoints. """[BETA] Set the return type of torch operations on datapoints.
This only affects the behaviour of torch operations. It has no effect on This only affects the behaviour of torch operations. It has no effect on
``torchvision`` transforms or functionals, which will always return as ``torchvision`` transforms or functionals, which will always return as
......
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