Skip to content

download parameter of KMNIST() should be explained at the end #8786

@hyperkai

Description

@hyperkai

📚 The doc issue

The doc of KMNIST() says download parameter is at the end as shown below:

class torchvision.datasets.KMNIST(root: Union[str, Path], train: bool = True, transform: Optional[Callable] = None, target_transform: Optional[Callable] = None, download: bool = False)

But download parameter is explained in the middle as shown below:

Parameters:

  • root (str or pathlib.Path) – Root directory of dataset where KMNIST/raw/train-images-idx3-ubyte and KMNIST/raw/t10k-images-idx3-ubyte exist.
  • train (bool, optional) – If True, creates dataset from train-images-idx3-ubyte, otherwise from t10k-images-idx3-ubyte.
  • 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 PIL image and returns a transformed version. E.g, transforms.RandomCrop
  • target_transform (callable, optional) – A function/transform that takes in the target and transforms it.

Suggest a potential alternative/fix

So download parameter should be explained at the end as shown below:

Parameters:

  • root (str or pathlib.Path) – Root directory of dataset where KMNIST/raw/train-images-idx3-ubyte and KMNIST/raw/t10k-images-idx3-ubyte exist.
  • train (bool, optional) – If True, creates dataset from train-images-idx3-ubyte, otherwise from t10k-images-idx3-ubyte.
  • transform (callable, optional) – A function/transform that takes in a PIL image and returns a transformed version. E.g, transforms.RandomCrop
  • target_transform (callable, optional) – A function/transform that takes in the target and transforms it.
  • 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.

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