Skip to content

Commit 0e80296

Browse files
oke-adityadatumbox
andauthored
[DOC] Add docs for missing datasets (#3536)
* add missing docs * tries fixing docs * fixes docs * fixes ..code Co-authored-by: Vasilis Vryniotis <[email protected]>
1 parent 652a70f commit 0e80296

File tree

4 files changed

+34
-1
lines changed

4 files changed

+34
-1
lines changed

docs/source/datasets.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,18 @@ All the datasets have almost similar API. They all have two common arguments:
2424

2525
.. currentmodule:: torchvision.datasets
2626

27+
28+
Caltech
29+
~~~~~~~
30+
31+
.. autoclass:: Caltech101
32+
:members: __getitem__
33+
:special-members:
34+
35+
.. autoclass:: Caltech256
36+
:members: __getitem__
37+
:special-members:
38+
2739
CelebA
2840
~~~~~~
2941

@@ -192,6 +204,13 @@ SBU
192204
:members: __getitem__
193205
:special-members:
194206

207+
SEMEION
208+
~~~~~~~
209+
210+
.. autoclass:: SEMEION
211+
:members: __getitem__
212+
:special-members:
213+
195214
STL10
196215
~~~~~
197216

@@ -231,3 +250,9 @@ VOC
231250
:members: __getitem__
232251
:special-members:
233252

253+
WIDERFace
254+
~~~~~~~~~
255+
256+
.. autoclass:: WIDERFace
257+
:members: __getitem__
258+
:special-members:

torchvision/datasets/kinetics.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ class Kinetics400(VisionDataset):
2424
2525
Args:
2626
root (string): Root directory of the Kinetics-400 Dataset. Should be structured as follows:
27+
2728
.. code::
2829
2930
root/

torchvision/datasets/semeion.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88

99

1010
class SEMEION(VisionDataset):
11-
"""`SEMEION <http://archive.ics.uci.edu/ml/datasets/semeion+handwritten+digit>`_ Dataset.
11+
r"""`SEMEION <http://archive.ics.uci.edu/ml/datasets/semeion+handwritten+digit>`_ Dataset.
12+
1213
Args:
1314
root (string): Root directory of dataset where directory
1415
``semeion.py`` exists.
@@ -19,6 +20,7 @@ class SEMEION(VisionDataset):
1920
download (bool, optional): If true, downloads the dataset from the internet and
2021
puts it in root directory. If dataset is already downloaded, it is not
2122
downloaded again.
23+
2224
"""
2325
url = "http://archive.ics.uci.edu/ml/machine-learning-databases/semeion/semeion.data"
2426
filename = "semeion.data"
@@ -53,6 +55,7 @@ def __getitem__(self, index: int) -> Tuple[Any, Any]:
5355
"""
5456
Args:
5557
index (int): Index
58+
5659
Returns:
5760
tuple: (image, target) where target is index of the target class.
5861
"""

torchvision/datasets/widerface.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ class WIDERFace(VisionDataset):
1414
Args:
1515
root (string): Root directory where images and annotations are downloaded to.
1616
Expects the following folder structure if download=False:
17+
18+
.. code::
19+
1720
<root>
1821
└── widerface
1922
├── wider_face_split ('wider_face_split.zip' if compressed)
@@ -29,6 +32,7 @@ class WIDERFace(VisionDataset):
2932
download (bool, optional): If true, downloads the dataset from the internet and
3033
puts it in root directory. If dataset is already downloaded, it is not
3134
downloaded again.
35+
3236
"""
3337

3438
BASE_FOLDER = "widerface"

0 commit comments

Comments
 (0)