datasets.rst 4.06 KB
Newer Older
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
1
2
torchvision.datasets
====================
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
3
4
5
6

All datasets are subclasses of :class:`torch.utils.data.Dataset`
i.e, they have ``__getitem__`` and ``__len__`` methods implemented.
Hence, they can all be passed to a :class:`torch.utils.data.DataLoader`
7
which can load multiple samples in parallel using ``torch.multiprocessing`` workers.
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
8
For example: ::
9

10
    imagenet_data = torchvision.datasets.ImageNet('path/to/imagenet_root/')
11
    data_loader = torch.utils.data.DataLoader(imagenet_data,
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
12
13
14
15
                                              batch_size=4,
                                              shuffle=True,
                                              num_workers=args.nThreads)

16
.. currentmodule:: torchvision.datasets
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
17
18
19

All the datasets have almost similar API. They all have two common arguments:
``transform`` and  ``target_transform`` to transform the input and target respectively.
20
You can also create your own datasets using the provided :ref:`base classes <base_classes_datasets>`.
21
22
23
24
25
26
27
28
29
30
31
32

Caltech
~~~~~~~

.. autoclass:: Caltech101
  :members: __getitem__
  :special-members:

.. autoclass:: Caltech256
  :members: __getitem__
  :special-members:

33
34
CelebA
~~~~~~
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
35

36
37
38
.. autoclass:: CelebA
  :members: __getitem__
  :special-members:
hysts's avatar
hysts committed
39

40
41
CIFAR
~~~~~
42

43
44
45
.. autoclass:: CIFAR10
  :members: __getitem__
  :special-members:
46

47
.. autoclass:: CIFAR100
48

49
50
Cityscapes
~~~~~~~~~~
51

52
53
.. note ::
    Requires Cityscape to be downloaded.
54

55
56
57
.. autoclass:: Cityscapes
  :members: __getitem__
  :special-members:
58

Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
COCO
~~~~

.. note ::
    These require the `COCO API to be installed`_

.. _COCO API to be installed: https://github.com/pdollar/coco/tree/master/PythonAPI


Captions
^^^^^^^^

.. autoclass:: CocoCaptions
  :members: __getitem__
  :special-members:


Detection
^^^^^^^^^

.. autoclass:: CocoDetection
  :members: __getitem__
  :special-members:

83

84
85
EMNIST
~~~~~~
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
86

87
.. autoclass:: EMNIST
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
88

89
90
FakeData
~~~~~~~~
91

92
.. autoclass:: FakeData
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
93

94
95
Fashion-MNIST
~~~~~~~~~~~~~
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
96

97
.. autoclass:: FashionMNIST
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
98

99
100
101
102
Flickr
~~~~~~

.. autoclass:: Flickr8k
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
103
104
105
  :members: __getitem__
  :special-members:

106
.. autoclass:: Flickr30k
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
107
108
109
  :members: __getitem__
  :special-members:

110
111
HMDB51
~~~~~~~
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
112

113
.. autoclass:: HMDB51
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
114
115
116
  :members: __getitem__
  :special-members:

117
118
ImageNet
~~~~~~~~~~~
119

120
.. autoclass:: ImageNet
121

122
123
124
.. note ::
    This requires `scipy` to be installed

dgenzel2's avatar
dgenzel2 committed
125
126
127
128
129
130
iNaturalist
~~~~~~~~~~~

.. autoclass:: INaturalist
  :members: __getitem__, category_name

131
132
133
134
Kinetics-400
~~~~~~~~~~~~

.. autoclass:: Kinetics400
135
136
137
  :members: __getitem__
  :special-members:

Prabhat Roy's avatar
Prabhat Roy committed
138
139
140
141
142
143
144
KITTI
~~~~~~~~~

.. autoclass:: Kitti
  :members: __getitem__
  :special-members:

145
146
KMNIST
~~~~~~~~~~~~~
147

148
.. autoclass:: KMNIST
149

150
151
LSUN
~~~~
152

153
.. autoclass:: LSUN
154
155
  :members: __getitem__
  :special-members:
156

157
158
159
160
161
162
MNIST
~~~~~

.. autoclass:: MNIST

Omniglot
163
~~~~~~~~
164

165
.. autoclass:: Omniglot
166

167
168
PhotoTour
~~~~~~~~~
169

170
.. autoclass:: PhotoTour
171
172
  :members: __getitem__
  :special-members:
Michael Kösel's avatar
Michael Kösel committed
173

Philip Meier's avatar
Philip Meier committed
174
175
176
177
178
179
180
Places365
~~~~~~~~~

.. autoclass:: Places365
  :members: __getitem__
  :special-members:

181
182
QMNIST
~~~~~~
Michael Kösel's avatar
Michael Kösel committed
183

184
.. autoclass:: QMNIST
185
186
187
188
189
190
191

SBD
~~~~~~

.. autoclass:: SBDataset
  :members: __getitem__
  :special-members:
Francisco Massa's avatar
Francisco Massa committed
192

193
194
SBU
~~~
Francisco Massa's avatar
Francisco Massa committed
195

196
.. autoclass:: SBU
Francisco Massa's avatar
Francisco Massa committed
197
198
  :members: __getitem__
  :special-members:
199

200
201
202
203
204
205
206
SEMEION
~~~~~~~

.. autoclass:: SEMEION
  :members: __getitem__
  :special-members:

207
208
STL10
~~~~~
209

210
.. autoclass:: STL10
211
212
  :members: __getitem__
  :special-members:
213

214
215
SVHN
~~~~~
216

217
.. autoclass:: SVHN
218
219
220
221
222
223
224
225
226
  :members: __getitem__
  :special-members:

UCF101
~~~~~~~

.. autoclass:: UCF101
  :members: __getitem__
  :special-members:
227

228
229
USPS
~~~~~
230

231
.. autoclass:: USPS
232
233
  :members: __getitem__
  :special-members:
234

235
VOC
236
237
~~~~~~

238
239
240
241
242
243
244
245
.. autoclass:: VOCSegmentation
  :members: __getitem__
  :special-members:

.. autoclass:: VOCDetection
  :members: __getitem__
  :special-members:

246
247
248
249
250
251
WIDERFace
~~~~~~~~~

.. autoclass:: WIDERFace
  :members: __getitem__
  :special-members:
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266


.. _base_classes_datasets:

Base classes for custom datasets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: DatasetFolder
  :members: __getitem__, find_classes, make_dataset
  :special-members:


.. autoclass:: ImageFolder
  :members: __getitem__
  :special-members:
267
268
269
270

.. autoclass:: VisionDataset
  :members: __getitem__
  :special-members: