Skip to content

Commit 7e61f8d

Browse files
kashifsoumith
authored andcommitted
added fashion-mnist to docs (#327)
1 parent 3d597bc commit 7e61f8d

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

docs/source/datasets.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ MNIST
3030

3131
.. autoclass:: MNIST
3232

33+
Fashion-MNIST
34+
~~~~~~~~~~~~~
35+
36+
.. autoclass:: FashionMNIST
37+
3338
COCO
3439
~~~~
3540

torchvision/datasets/mnist.py

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,20 @@ def download(self):
140140

141141

142142
class FashionMNIST(MNIST):
143-
"""`Fashion MNIST <https://github.com/zalandoresearch/fashion-mnist>`_ Dataset.
143+
"""`Fashion-MNIST <https://github.com/zalandoresearch/fashion-mnist>`_ Dataset.
144+
145+
Args:
146+
root (string): Root directory of dataset where ``processed/training.pt``
147+
and ``processed/test.pt`` exist.
148+
train (bool, optional): If True, creates dataset from ``training.pt``,
149+
otherwise from ``test.pt``.
150+
download (bool, optional): If true, downloads the dataset from the internet and
151+
puts it in root directory. If dataset is already downloaded, it is not
152+
downloaded again.
153+
transform (callable, optional): A function/transform that takes in an PIL image
154+
and returns a transformed version. E.g, ``transforms.RandomCrop``
155+
target_transform (callable, optional): A function/transform that takes in the
156+
target and transforms it.
144157
"""
145158
urls = [
146159
'http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-images-idx3-ubyte.gz',

0 commit comments

Comments
 (0)