Set5HR#

class deepinv.datasets.Set5HR(root=None, download=False, transform=None, verbose=True, use_dict_output=False)[source]#

Bases: ImageFolder

Dataset for Set5.

The Set5 dataset [1] is a dataset consisting of 5 images commonly used for testing performance of image reconstruction algorithms. Images have sizes ranging from 256Γ—256 to 512Γ—512 pixels.

Raw data file structure:

self.root --- Set5_HR.tar.gz
        |
        --- Set5_HR --- baby.png
        |             |
        |             --- bird.png
        |             --- butterfly.png
        |             --- ...
        |
        --- xxx

Raw dataset source : https://huggingface.co/datasets/eugenesiow/Set5

Parameters:
  • root (str) – Root directory of dataset. Directory path from where we load and save the dataset.

  • download (bool) – If True, downloads the dataset from the internet and puts it in root directory. If dataset is already downloaded, it is not downloaded again. Default at False.

  • transform: (Callable) – (optional) A function/transform that takes in a PIL image and returns a transformed version. E.g, torchvision.transforms.RandomCrop

  • verbose (bool) – Print a message if the dataset has been correctly downloaded. Default True.

  • use_dict_output (bool) – whether to return output as dict with keys β€œx”, β€œy”, β€œparams” instead of tuple (default False).


References:

check_dataset_exists()[source]#

Verify that the image folders exist and contain all the images.

self.root should have the following structure:

self.root --- Set5_HR --- baby.png
        |             |
        |             --- bird.png
        |             --- butterfly.png
        |             --- ...
        |
        --- xxx