Standardization of the datasets
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17.9k
- Forks
- 7.3k
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 13
Description
This is a discussion issue which was kicked of by #1067. Some PRs that contain ideas are #1015 and #1025. I will update this comment regularly with the achieved consensus during the discussion.
Disclaimer: I have never worked with segmentation or detection datasets. If I make same wrong assumption regarding them, feel free to correct me. Furthermore, please help me to fill in the gaps.
Proposed Structure
This issues presents the idea to standardize the torchvision.datasets. This could be done by adding parameters to the VisionDataset (split) or by subclassing it and add task specific parameters (classes or class_to_idx) to the new classes. I imagine it something like this:
import torch.utils.data as data
class VisionDataset(data.Dataset):
pass
class ClassificationDataset(VisionDataset):
pass
class SegmentationDataset(VisionDataset):
pass
class DetectionDataset(VisionDataset):
pass
For our tests we could then have a generic_*_dataset_test as is already implement for ClassificationDatasets.
VisionDataset
-
As discussed in #1067 we could unify the argument that selects different parts of the dataset. IMO
splitas astris the most general, but still clear term for this. I would implement this as positional argument within the constructor. This should work for all datasets, since in order to be useful each dataset should have at least a training and a test split. Exceptions to this are theFakedataandImageFolderdatasets, which will be discussed separately. -
IMO every dataset should have a
_downloadmethod in order to be useful for every user of this package. We could have the constructor havedownload=Trueas keyword argument and call thedownloadmethod within it. As above, theFakedataandImageFolderdatasets will be discussed below.
Fakedata and ImageFolder
What makes these two datasets special, is that there is nothing to download and they are not splitted in any way. IMO they are not special enough to not generalise the VisionDataset as stated above. I propose that we simply remove the split and download argument from their constructor and raise an exception if someone calls the download method.
Furthermore the Fakedata dataset is currently a ClassificationDataset. We should also create a FakeSegmentationData and a FakeDetectionData dataset.
ClassificationDataset
The following datasets belong to this category: CIFAR*, ImageNet, *MNIST, SVHN, LSUN, SEMEION, STL10, USPS, Caltech*
- Each dataset should return
PIL.Image, intif indexed - Each dataset should have a
classesparameter, which is atuplewith all available classes in human-readable form - Currently, some datasets have a
class_to_idxparameter, which is dictionary that maps the human-readable class to its index used as target. I propose to change the direction, i.e. create aidx_to_classparameter, since IMO this is the far more common transformation.
SegmentationDataset
The following datasets belong to this category: VOCSegmentation
DetectionDataset
The following datasets belong to this category: CocoDetection, VOCDetection
ToDo
- The following datasets need sorting into the three categories:
,Caltech101,Caltech256
CelebA,CityScapes,Cococaptions,Flickr8k,Flickr30k,,LSUNOmniglot,PhotoTour,SBDataset(shouldn't this be just calledSBD?),SBU,,SEMEION, andSTL10USPS Add some common arguments / parameters for theSegmentationDatasetandDetectionDataset
Thoughts and suggestions?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the discussion from #1067 and the example ideas in PRs #1015 and #1025. Review the proposed VisionDataset, ClassificationDataset, SegmentationDataset, and DetectionDataset structure, along with the existing generic classification dataset tests. Done requires reaching consensus on the standardization approach and sorting or updating the listed datasets accordingly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- computer-vision
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100