Skip to content
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.

Sign up for GitHub

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

Categorize dataset doc page into sections #5368

Merged
merged 2 commits into from
Feb 3, 2022
Merged

Categorize dataset doc page into sections #5368

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89d3adb
Categorize dataset doc page into sections
NicolasHug Feb 3, 2022
fed9ac0
Merge branch 'main' into dataset_docs
NicolasHug Feb 3, 2022
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
90 changes: 68 additions & 22 deletions docs/source/datasets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Torchvision provides many built-in datasets in the ``torchvision.datasets``
module, as well as utility classes for building your own datasets.

Built-in datasets
~~~~~~~~~~~~~~~~~
-----------------

All datasets are subclasses of :class:`torch.utils.data.Dataset`
i.e, they have ``__getitem__`` and ``__len__`` methods implemented.
Expand All @@ -25,6 +25,8 @@ All the datasets have almost similar API. They all have two common arguments:
``transform`` and ``target_transform`` to transform the input and target respectively.
You can also create your own datasets using the provided :ref:`base classes <base_classes_datasets>`.

Image classification
~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated/
Expand All @@ -35,61 +37,105 @@ You can also create your own datasets using the provided :ref:`base classes <bas
CelebA
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CelebA is image generation too.

CIFAR10
CIFAR100
Cityscapes
CocoCaptions
CocoDetection
Country211
DTD
EMNIST
EuroSAT
FakeData
FashionMNIST
FER2013
FGVCAircraft
Flickr8k
Flickr30k
Flowers102
FlyingChairs
FlyingThings3D
Food101
FGVCAircraft
GTSRB
HD1K
HMDB51
ImageNet
INaturalist
Kinetics400
Kitti
KittiFlow
ImageNet
KMNIST
LFWPeople
LFWPairs
LSUN
Copy link
Contributor

@oke-aditya oke-aditya Feb 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LSUN
Image Generation probably? This is how paperswithcode describes it as well. Also GANs are popular on this.

MNIST
Omniglot
OxfordIIITPet
PCAM
PhotoTour
Places365
RenderedSST2
PCAM
QMNIST
SBDataset
SBU
RenderedSST2
SEMEION
Sintel
SBU
StanfordCars
STL10
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tihnk STL-10 is used for g unsupervised learning. Although it can be used for image classification too.
That's how the website describes it https://cs.stanford.edu/~acoates/stl10/

SUN397
SVHN
UCF101
USPS

Image detection or segmentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated/
:template: class_dataset.rst

CocoDetection
CelebA
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some datasets here also appear in the Classification section:

  • CelebA
  • GTSRB
  • OxfordIIITPet

Perhaps there are others that I missed?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is fine to have them in both categories, since they can be used for both tasks. Looking through list, nothing missing comes to mind.

Cityscapes
GTSRB
Kitti
OxfordIIITPet
SBDataset
VOCSegmentation
VOCDetection
WIDERFace

Optical Flow
~~~~~~~~~~~~

.. autosummary::
:toctree: generated/
:template: class_dataset.rst

FlyingChairs
FlyingThings3D
HD1K
KittiFlow
Sintel

Image pairs
~~~~~~~~~~~

.. autosummary::
:toctree: generated/
:template: class_dataset.rst

LFWPairs
PhotoTour

Image captioning
~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated/
:template: class_dataset.rst

CocoCaptions
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't sure what to do with this one so I created a section just for it. There might be a better alternative?


Video classification
~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated/
:template: class_dataset.rst

HMDB51
Kinetics400
UCF101


.. _base_classes_datasets:

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

.. autosummary::
:toctree: generated/
Expand Down