Initial commit.

PIRM.py

@@ -0,0 +1,155 @@
+# coding=utf-8
+# Copyright 2020 The HuggingFace Datasets Authors and the current dataset script contributor.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""PIRM dataset: An validation and test dataset for the image super resolution task"""
+
+
+import datasets
+from pathlib import Path
+
+
+_CITATION = """
+@misc{shoeiby2019pirm2018,
+  title={PIRM2018 Challenge on Spectral Image Super-Resolution: Dataset and Study}, 
+  author={Mehrdad Shoeiby and Antonio Robles-Kelly and Ran Wei and Radu Timofte},
+  year={2019},
+  eprint={1904.00540},
+  archivePrefix={arXiv},
+  primaryClass={cs.CV}
+}
+"""
+
+_DESCRIPTION = """
+The PIRM dataset consists of 200 images, which are divided into two equal sets for validation and testing. 
+These images cover diverse contents, including people, objects, environments, flora, natural scenery, etc. 
+Images vary in size, and are typically ~300K pixels in resolution.
+
+This dataset was first used for evaluating the perceptual quality of super-resolution algorithms in The 2018 PIRM 
+challenge on Perceptual Super-resolution, in conjunction with ECCV 2018.
+"""
+
+_HOMEPAGE = "https://github.com/roimehrez/PIRM2018"
+
+_LICENSE = "cc-by-nc-sa-4.0"
+
+_DL_URL = "https://huggingface.co/datasets/eugenesiow/PIRM/resolve/main/data/"
+
+_DEFAULT_CONFIG = "bicubic_x2"
+
+_DATA_OPTIONS = {
+    "bicubic_x2": {
+        "hr_test": _DL_URL + "PIRM_test_HR.tar.gz",
+        "lr_test": _DL_URL + "PIRM_test_LR_x2.tar.gz",
+        "hr_valid": _DL_URL + "PIRM_valid_HR.tar.gz",
+        "lr_valid": _DL_URL + "PIRM_valid_LR_x2.tar.gz",
+    },
+    "bicubic_x3": {
+        "hr_test": _DL_URL + "PIRM_test_HR.tar.gz",
+        "lr_test": _DL_URL + "PIRM_test_LR_x3.tar.gz",
+        "hr_valid": _DL_URL + "PIRM_valid_HR.tar.gz",
+        "lr_valid": _DL_URL + "PIRM_valid_LR_x3.tar.gz",
+    },
+    "bicubic_x4": {
+        "hr_test": _DL_URL + "PIRM_test_HR.tar.gz",
+        "lr_test": _DL_URL + "PIRM_test_LR_x4.tar.gz",
+        "hr_valid": _DL_URL + "PIRM_valid_HR.tar.gz",
+        "lr_valid": _DL_URL + "PIRM_valid_LR_x4.tar.gz",
+    },
+    "unknown_x4": {
+        "hr_test": _DL_URL + "PIRM_test_HR.tar.gz",
+        "lr_test": _DL_URL + "PIRM_test_LR_unknown_x4.tar.gz",
+        "hr_valid": _DL_URL + "PIRM_valid_HR.tar.gz",
+        "lr_valid": _DL_URL + "PIRM_valid_LR_unknown_x4.tar.gz",
+    }
+}
+
+
+class PirmConfig(datasets.BuilderConfig):
+    """BuilderConfig for PIRM."""
+
+    def __init__(
+        self,
+        name,
+        download_urls,
+        **kwargs,
+    ):
+        if name not in _DATA_OPTIONS:
+            raise ValueError("data must be one of %s" % _DATA_OPTIONS)
+        super(PirmConfig, self).__init__(name=name, version=datasets.Version("1.0.0"), **kwargs)
+        self.download_urls = download_urls
+
+
+class Pirm(datasets.GeneratorBasedBuilder):
+    """PIRM dataset for single image super resolution test and validation."""
+
+    BUILDER_CONFIGS = [
+        PirmConfig(
+            name=key,
+            download_urls=values,
+        ) for key, values in _DATA_OPTIONS.items()
+    ]
+
+    DEFAULT_CONFIG_NAME = _DEFAULT_CONFIG
+
+    def _info(self):
+        features = datasets.Features(
+            {
+                "hr": datasets.Value("string"),
+                "lr": datasets.Value("string"),
+            }
+        )
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=features,
+            supervised_keys=None,
+            homepage=_HOMEPAGE,
+            license=_LICENSE,
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        extracted_paths = dl_manager.download_and_extract(
+            self.config.download_urls)
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                gen_kwargs={
+                    "lr_path": extracted_paths["lr_valid"],
+                    "hr_path": str(Path(extracted_paths["hr_valid"]) / 'PIRM_valid_HR')
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                gen_kwargs={
+                    "lr_path": extracted_paths["lr_test"],
+                    "hr_path": str(Path(extracted_paths["hr_test"]) / 'PIRM_test_HR')
+                },
+            )
+        ]
+
+    def _generate_examples(
+        self, hr_path, lr_path
+    ):
+        """ Yields examples as (key, example) tuples. """
+        # This method handles input defined in _split_generators to yield (key, example) tuples from the dataset.
+        # The `key` is here for legacy reason (tfds) and is not important in itself.
+        extensions = {'.png'}
+        for file_path in sorted(Path(lr_path).glob("**/*")):
+            if file_path.suffix in extensions:
+                file_path_str = str(file_path.as_posix())
+                yield file_path_str, {
+                    'lr': file_path_str,
+                    'hr': str((Path(hr_path) / file_path.name).as_posix())
+                }

README.md

@@ -0,0 +1,193 @@
+---
+annotations_creators:
+- machine-generated
+language_creators:
+- found
+languages: []
+licenses:
+- cc-by-nc-sa-4.0
+multilinguality:
+- monolingual
+pretty_name: PIRM
+size_categories:
+- unknown
+source_datasets:
+- original
+task_categories:
+- other
+task_ids:
+- other-other-image-super-resolution
+---
+
+# Dataset Card for PIRM
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
+
+## Dataset Description
+
+- **Homepage**: https://github.com/roimehrez/PIRM2018
+- **Repository**: https://huggingface.co/datasets/eugenesiow/PIRM
+- **Paper**: https://arxiv.org/abs/1809.07517
+- **Leaderboard**: https://github.com/eugenesiow/super-image#scale-x2
+
+### Dataset Summary
+
+The PIRM dataset consists of 200 images, which are divided into two equal sets for validation and testing. 
+These images cover diverse contents, including people, objects, environments, flora, natural scenery, etc. 
+Images vary in size, and are typically ~300K pixels in resolution.
+
+This dataset was first used for evaluating the perceptual quality of super-resolution algorithms in The 2018 PIRM 
+challenge on Perceptual Super-resolution, in conjunction with ECCV 2018.
+
+Install with `pip`:
+```bash
+pip install datasets super-image
+```
+
+Evaluate a model with the [`super-image`](https://github.com/eugenesiow/super-image) library:
+```python
+from datasets import load_dataset
+from super_image import EdsrModel
+from super_image.data import EvalDataset, EvalMetrics
+
+dataset = load_dataset('eugenesiow/PIRM', 'bicubic_x2', split='validation')
+eval_dataset = EvalDataset(dataset)
+model = EdsrModel.from_pretrained('eugenesiow/edsr-base', scale=2)
+EvalMetrics().evaluate(model, eval_dataset)
+```
+
+### Supported Tasks and Leaderboards
+
+The dataset is commonly used for evaluation of the `image-super-resolution` task.
+
+Unofficial [`super-image`](https://github.com/eugenesiow/super-image) leaderboard for:
+- [Scale 2](https://github.com/eugenesiow/super-image#scale-x2)
+- [Scale 3](https://github.com/eugenesiow/super-image#scale-x3)
+- [Scale 4](https://github.com/eugenesiow/super-image#scale-x4)
+- [Scale 8](https://github.com/eugenesiow/super-image#scale-x8)
+
+### Languages
+
+Not applicable.
+
+## Dataset Structure
+
+### Data Instances
+
+An example of `validation` for `bicubic_x2` looks as follows.
+```
+{
+    "hr": "/.cache/huggingface/datasets/downloads/extracted/PIRM_valid_HR/1.png",
+    "lr": "/.cache/huggingface/datasets/downloads/extracted/PIRM_valid_LR_x2/1.png"
+}
+```
+
+### Data Fields
+
+The data fields are the same among all splits.
+
+- `hr`: a `string` to the path of the High Resolution (HR) `.png` image.
+- `lr`: a `string` to the path of the Low Resolution (LR) `.png` image.
+
+### Data Splits
+
+| name  |validation|test|
+|-------|---:|---:|
+|bicubic_x2|100|100|
+|bicubic_x3|100|100|
+|bicubic_x4|100|100|
+|unknown_x4|100|100|
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+No annotations.
+
+#### Who are the annotators?
+
+No annotators.
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+- **Original Authors**: [Blau et al. (2018)](https://arxiv.org/abs/1809.07517)
+
+### Licensing Information
+
+This dataset is published under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
+
+### Citation Information
+
+```bibtex
+@misc{blau20192018,
+    title={The 2018 PIRM Challenge on Perceptual Image Super-resolution}, 
+    author={Yochai Blau and Roey Mechrez and Radu Timofte and Tomer Michaeli and Lihi Zelnik-Manor},
+    year={2019},
+    eprint={1809.07517},
+    archivePrefix={arXiv},
+    primaryClass={cs.CV}
+}
+```
+
+### Contributions
+
+Thanks to [@eugenesiow](https://github.com/eugenesiow) for adding this dataset.

data/PIRM_test_HR.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:722d9d12835b5a101327b7252f9f513266208e6f9c63d62c5469633ab9d5f8f0
+size 53252850

data/PIRM_test_LR_unknown_x4.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c00ce09b637dd5b46d3786e9978be088acec80ecbc6da12dfb486386bd71d7c3
+size 3683703

data/PIRM_test_LR_x2.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a365aca6499c043326d2732f54b56129a2398a9adf7f484c339019a9e12ba210
+size 14047897

data/PIRM_test_LR_x3.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:711b7b79ccd1507e6db1e42145c3443750a09992780d30bcf823ade110377b2c
+size 6450434

data/PIRM_test_LR_x4.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2026c21b1167b3746cf11d587527f39836ceda22964aec7c6d262fc731016a48
+size 3715004

data/PIRM_valid_HR.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:edea941b7c2449d7f6074ebd513ca102fa2d8597c09f6127d2cc39c02414e48c
+size 51785319

data/PIRM_valid_LR_unknown_x4.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:257e8326db1cd331fb9cb433936f613e644b08df3bd8448c6328ce5c9831308b
+size 3613501

data/PIRM_valid_LR_x2.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:da23f799bf2ecef10e613445f44fec2d5879fa08d0d119787f8fcd675a733a7e
+size 13687321

data/PIRM_valid_LR_x3.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a82751e82aaa6a95da7bb19747a18eb9302945c53e0b6f858b9d60c77afb4e1f
+size 6293280

data/PIRM_valid_LR_x4.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:59d3c017fdb2cd958a74372acc123c549431f4ac8311d4c58a7101d0b12c0bac
+size 3638593