Skip to content

download parameter of MovingMNIST() should be explained before transform parameter #8789

@hyperkai

Description

@hyperkai

📚 The doc issue

The doc of MovingMNIST() says that download parameter is before transform parameter as shown below:

class torchvision.datasets.MovingMNIST(root: Union[str, Path], split: Optional[str] = None, split_ratio: int = 10, download: bool = False, transform: Optional[Callable] = None)

But download parameter is explained after transform parameter as shown below:

Parameters
...

  • split_ratio (int, optional) – The split ratio of number of frames. If split="train", the first split frames data[:, :split_ratio] is returned. If split="test", the last split frames data[:, split_ratio:] is returned. If split=None, this parameter is ignored and the all frames data is returned.
  • transform (callable, optional) – A function/transform that takes in a torch Tensor and returns a transformed version. E.g, transforms.RandomCrop
  • download (bool, optional) – If true, downloads the dataset from the internet and puts it in root directory. If dataset is already downloaded, it is not downloaded again.

Suggest a potential alternative/fix

So download parameter should be explained before transform parameter as shown below:

Parameters
...

  • split_ratio (int, optional) – The split ratio of number of frames. If split="train", the first split frames data[:, :split_ratio] is returned. If split="test", the last split frames data[:, split_ratio:] is returned. If split=None, this parameter is ignored and the all frames data is returned.
  • download (bool, optional) – If true, downloads the dataset from the internet and puts it in root directory. If dataset is already downloaded, it is not downloaded again.
  • transform (callable, optional) – A function/transform that takes in a torch Tensor and returns a transformed version. E.g, transforms.RandomCrop

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions