Skip to content

add MNIST dataset to docs. Improve formatting of LSUN docs #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 21, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Datasets

The following dataset loaders are available:

- `MNIST <#mnist>`__
- `COCO (Captioning and Detection) <#coco>`__
- `LSUN Classification <#lsun>`__
- `ImageFolder <#imagefolder>`__
Expand All @@ -66,6 +67,21 @@ but they all take the keyword args:
transforms it. For example, take in the caption string and return a
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
~~~~

Expand Down Expand Up @@ -115,12 +131,12 @@ LSUN

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

- db\_path = root directory for the database files
- classes =
- 'train' - all categories, training set
- 'val' - all categories, validation set
- 'test' - all categories, test set
- ['bedroom\_train', 'church\_train', ...] : a list of categories to
- ``db_path`` = root directory for the database files
- ``classes`` =
- ``'train'`` - all categories, training set
- ``'val'`` - all categories, validation set
- ``'test'`` - all categories, test set
- [``'bedroom_train'``, ``'church_train'``, ...] : a list of categories to
load

CIFAR
Expand Down