Commit 1dc5724a authored by Alykhan Tejani's avatar Alykhan Tejani
Browse files

add MNIST dataset to docs. Improve formatting of LSUN docs

parent 6f342d3a
...@@ -40,6 +40,7 @@ Datasets ...@@ -40,6 +40,7 @@ Datasets
The following dataset loaders are available: The following dataset loaders are available:
- `MNIST <#mnist>`__
- `COCO (Captioning and Detection) <#coco>`__ - `COCO (Captioning and Detection) <#coco>`__
- `LSUN Classification <#lsun>`__ - `LSUN Classification <#lsun>`__
- `ImageFolder <#imagefolder>`__ - `ImageFolder <#imagefolder>`__
...@@ -66,6 +67,21 @@ but they all take the keyword args: ...@@ -66,6 +67,21 @@ but they all take the keyword args:
transforms it. For example, take in the caption string and return a transforms it. For example, take in the caption string and return a
tensor of word indices. tensor of word indices.
MNIST
~~~~~
``dset.MNIST(root, train=True, transform=None, target_transform=None, download=False)``
``root``: root directory of dataset where ``processed/training.pt`` and ``training/test.pt`` exist
``train``: ``True`` - use training set, ``False`` - use test set.
``transform``: transform to apply to input images
``target_transform``: transform to apply to targets (class labels)
``download``: whether to download the MNIST data
COCO COCO
~~~~ ~~~~
...@@ -115,12 +131,12 @@ LSUN ...@@ -115,12 +131,12 @@ LSUN
``dset.LSUN(db_path, classes='train', [transform, target_transform])`` ``dset.LSUN(db_path, classes='train', [transform, target_transform])``
- db\_path = root directory for the database files - ``db_path`` = root directory for the database files
- classes = - ``classes`` =
- 'train' - all categories, training set - ``'train'`` - all categories, training set
- 'val' - all categories, validation set - ``'val'`` - all categories, validation set
- 'test' - all categories, test set - ``'test'`` - all categories, test set
- ['bedroom\_train', 'church\_train', ...] : a list of categories to - [``'bedroom_train'``, ``'church_train'``, ...] : a list of categories to
load load
CIFAR CIFAR
......
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