Skip to content

Commit 46cbea5

Browse files
authored
Merge pull request #38 from alykhantejani/add_mnist_docs
add MNIST dataset to docs. Improve formatting of LSUN docs
2 parents 6f342d3 + 1dc5724 commit 46cbea5

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.rst

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Datasets
4040

4141
The following dataset loaders are available:
4242

43+
- `MNIST <#mnist>`__
4344
- `COCO (Captioning and Detection) <#coco>`__
4445
- `LSUN Classification <#lsun>`__
4546
- `ImageFolder <#imagefolder>`__
@@ -66,6 +67,21 @@ but they all take the keyword args:
6667
transforms it. For example, take in the caption string and return a
6768
tensor of word indices.
6869

70+
MNIST
71+
~~~~~
72+
``dset.MNIST(root, train=True, transform=None, target_transform=None, download=False)``
73+
74+
``root``: root directory of dataset where ``processed/training.pt`` and ``training/test.pt`` exist
75+
76+
``train``: ``True`` - use training set, ``False`` - use test set.
77+
78+
``transform``: transform to apply to input images
79+
80+
``target_transform``: transform to apply to targets (class labels)
81+
82+
``download``: whether to download the MNIST data
83+
84+
6985
COCO
7086
~~~~
7187

@@ -115,12 +131,12 @@ LSUN
115131

116132
``dset.LSUN(db_path, classes='train', [transform, target_transform])``
117133

118-
- db\_path = root directory for the database files
119-
- classes =
120-
- 'train' - all categories, training set
121-
- 'val' - all categories, validation set
122-
- 'test' - all categories, test set
123-
- ['bedroom\_train', 'church\_train', ...] : a list of categories to
134+
- ``db_path`` = root directory for the database files
135+
- ``classes`` =
136+
- ``'train'`` - all categories, training set
137+
- ``'val'`` - all categories, validation set
138+
- ``'test'`` - all categories, test set
139+
- [``'bedroom_train'``, ``'church_train'``, ...] : a list of categories to
124140
load
125141

126142
CIFAR

0 commit comments

Comments
 (0)