Skip to content

Clean up the documentation of transforms #3071

Closed
@datumbox

Description

@datumbox

📚 Documentation

The methods in functional_pil.py and functional_tensor.py are private but contain a lot of duplicate documentation that is not currently used. It's worth cleaning this up and updating the documentation on functional.py to highlight potential differences or limitations between the two backends.

Here is an example of how we typically highlight backend differences in TorchVision:

padding_mode (str): Type of padding. Should be: constant, edge, reflect or symmetric.
Default is constant. Mode symmetric is not yet supported for Tensor inputs.

Moreover as per @voldemortX's comment (see #3071 (comment)), some of the limitations listed in the pydocs are inaccurate and they have already been resolved. These need to be corrected.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions