Skip to content

GitLab

Commit ab86a3a1 authored by maria8899's avatar maria8899 Committed by Francisco Massa
Browse files

Update directory documentation (#778)

parent a2093007
Hide whitespace changes
Inline Side-by-side
Showing with 8 additions and 8 deletions
torchvision/datasets/mnist.py
View file @ ab86a3a1
...@@ -15,8 +15,8 @@ class MNIST(data.Dataset): ...@@ -15,8 +15,8 @@ class MNIST(data.Dataset):
"""`MNIST <http://yann.lecun.com/exdb/mnist/>`_ Dataset. """`MNIST <http://yann.lecun.com/exdb/mnist/>`_ Dataset.
Args: Args:
root (string): Root directory of dataset where ``processed/training.pt`` root (string): Root directory of dataset where ``MNIST/processed/training.pt``
and ``processed/test.pt`` exist. and ``MNIST/processed/test.pt`` exist.
train (bool, optional): If True, creates dataset from ``training.pt``, train (bool, optional): If True, creates dataset from ``training.pt``,
otherwise from ``test.pt``. otherwise from ``test.pt``.
download (bool, optional): If true, downloads the dataset from the internet and download (bool, optional): If true, downloads the dataset from the internet and
...@@ -178,8 +178,8 @@ class FashionMNIST(MNIST): ...@@ -178,8 +178,8 @@ class FashionMNIST(MNIST):
"""`Fashion-MNIST <https://github.com/zalandoresearch/fashion-mnist>`_ Dataset. """`Fashion-MNIST <https://github.com/zalandoresearch/fashion-mnist>`_ Dataset.
Args: Args:
root (string): Root directory of dataset where ``processed/training.pt`` root (string): Root directory of dataset where ``Fashion-MNIST/processed/training.pt``
and ``processed/test.pt`` exist. and ``Fashion-MNIST/processed/test.pt`` exist.
train (bool, optional): If True, creates dataset from ``training.pt``, train (bool, optional): If True, creates dataset from ``training.pt``,
otherwise from ``test.pt``. otherwise from ``test.pt``.
download (bool, optional): If true, downloads the dataset from the internet and download (bool, optional): If true, downloads the dataset from the internet and
...@@ -204,8 +204,8 @@ class KMNIST(MNIST): ...@@ -204,8 +204,8 @@ class KMNIST(MNIST):
"""`Kuzushiji-MNIST <https://github.com/rois-codh/kmnist>`_ Dataset. """`Kuzushiji-MNIST <https://github.com/rois-codh/kmnist>`_ Dataset.
Args: Args:
root (string): Root directory of dataset where ``processed/training.pt`` root (string): Root directory of dataset where ``KMNIST/processed/training.pt``
and ``processed/test.pt`` exist. and ``KMNIST/processed/test.pt`` exist.
train (bool, optional): If True, creates dataset from ``training.pt``, train (bool, optional): If True, creates dataset from ``training.pt``,
otherwise from ``test.pt``. otherwise from ``test.pt``.
download (bool, optional): If true, downloads the dataset from the internet and download (bool, optional): If true, downloads the dataset from the internet and
...@@ -229,8 +229,8 @@ class EMNIST(MNIST): ...@@ -229,8 +229,8 @@ class EMNIST(MNIST):
"""`EMNIST <https://www.westernsydney.edu.au/bens/home/reproducible_research/emnist>`_ Dataset. """`EMNIST <https://www.westernsydney.edu.au/bens/home/reproducible_research/emnist>`_ Dataset.
Args: Args:
root (string): Root directory of dataset where ``processed/training.pt`` root (string): Root directory of dataset where ``EMNIST/processed/training.pt``
and ``processed/test.pt`` exist. and ``EMNIST/processed/test.pt`` exist.
split (string): The dataset has 6 different splits: ``byclass``, ``bymerge``, split (string): The dataset has 6 different splits: ``byclass``, ``bymerge``,
``balanced``, ``letters``, ``digits`` and ``mnist``. This argument specifies ``balanced``, ``letters``, ``digits`` and ``mnist``. This argument specifies
which one to use. which one to use.
......
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