Duplicate from eugenesiow/Urban100

Co-authored-by: Eugene Siow <eugenesiow@users.noreply.huggingface.co>

.gitattributes

@@ -0,0 +1,16 @@
+*.bin.* filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tar.gz filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,188 @@
+---
+annotations_creators:
+- machine-generated
+language_creators:
+- found
+language: []
+license:
+- cc-by-4.0
+multilinguality:
+- monolingual
+size_categories:
+- unknown
+source_datasets:
+- original
+task_categories:
+- other
+task_ids: []
+pretty_name: Urban100
+tags:
+- other-image-super-resolution
+---
+
+# Dataset Card for Urban100
+
+## 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/jbhuang0604/SelfExSR
+- **Repository**: https://huggingface.co/datasets/eugenesiow/Urban100
+- **Paper**: https://openaccess.thecvf.com/content_cvpr_2015/html/Huang_Single_Image_Super-Resolution_2015_CVPR_paper.html
+- **Leaderboard**: https://github.com/eugenesiow/super-image#scale-x2
+
+### Dataset Summary
+
+The Urban100 dataset contains 100 images of urban scenes. It commonly used as a test set to evaluate the performance of super-resolution models. It was first published by [Huang et al. (2015)](https://openaccess.thecvf.com/content_cvpr_2015/html/Huang_Single_Image_Super-Resolution_2015_CVPR_paper.html) in the paper "Single Image Super-Resolution From Transformed Self-Exemplars".
+
+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/Urban100', '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/Urban100_HR/img_001.png",
+    "lr": "/.cache/huggingface/datasets/downloads/extracted/Urban100_LR_x2/img_001.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|
+|-------|---:|
+|bicubic_x2|100|
+|bicubic_x3|100|
+|bicubic_x4|100|
+
+
+## Dataset Creation
+
+### Curation Rationale
+
+The authors have created Urban100 containing 100 HR images with a variety of real-world structures.
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+The authors constructed this dataset using images from Flickr (under CC license) using keywords such as urban, city, architecture, and structure.
+
+#### 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**: [Huang et al. (2015)](https://github.com/jbhuang0604/SelfExSR) 
+
+### Licensing Information
+
+The dataset provided uses images from Flikr under the CC (CC-BY-4.0) license.
+
+### Citation Information
+
+```bibtex
+@InProceedings{Huang_2015_CVPR,
+  author = {Huang, Jia-Bin and Singh, Abhishek and Ahuja, Narendra},
+  title = {Single Image Super-Resolution From Transformed Self-Exemplars},
+  booktitle = {Proceedings of the IEEE Conference on Computer Vision and Pattern Recognition (CVPR)},
+  month = {June},
+  year = {2015}
+}
+```
+
+### Contributions
+
+Thanks to [@eugenesiow](https://github.com/eugenesiow) for adding this dataset.

Urban100.py

@@ -0,0 +1,137 @@
+# 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.
+"""Urban100 dataset: An evaluation dataset for the image super resolution task"""
+
+
+import datasets
+from pathlib import Path
+
+
+_CITATION = """
+@inproceedings{martin2001database,
+  title={A database of human segmented natural images and its application to evaluating segmentation algorithms and measuring ecological statistics},
+  author={Martin, David and Fowlkes, Charless and Tal, Doron and Malik, Jitendra},
+  booktitle={Proceedings Eighth IEEE International Conference on Computer Vision. ICCV 2001},
+  volume={2},
+  pages={416--423},
+  year={2001},
+  organization={IEEE}
+}
+"""
+
+_DESCRIPTION = """
+The Urban100 dataset contains 100 images of urban scenes. 
+It commonly used as a test set to evaluate the performance of super-resolution models.
+"""
+
+_HOMEPAGE = "https://github.com/jbhuang0604/SelfExSR"
+
+_LICENSE = "CC-BY-4.0"
+
+_DL_URL = "https://huggingface.co/datasets/eugenesiow/Urban100/resolve/main/data/"
+
+_DEFAULT_CONFIG = "bicubic_x2"
+
+_DATA_OPTIONS = {
+    "bicubic_x2": {
+        "hr": _DL_URL + "Urban100_HR.tar.gz",
+        "lr": _DL_URL + "Urban100_LR_x2.tar.gz",
+    },
+    "bicubic_x3": {
+        "hr": _DL_URL + "Urban100_HR.tar.gz",
+        "lr": _DL_URL + "Urban100_LR_x3.tar.gz",
+    },
+    "bicubic_x4": {
+        "hr": _DL_URL + "Urban100_HR.tar.gz",
+        "lr": _DL_URL + "Urban100_LR_x4.tar.gz",
+    }
+}
+
+
+class Urban100Config(datasets.BuilderConfig):
+    """BuilderConfig for Urban100."""
+
+    def __init__(
+        self,
+        name,
+        hr_url,
+        lr_url,
+        **kwargs,
+    ):
+        if name not in _DATA_OPTIONS:
+            raise ValueError("data must be one of %s" % _DATA_OPTIONS)
+        super(Urban100Config, self).__init__(name=name, version=datasets.Version("1.0.0"), **kwargs)
+        self.hr_url = hr_url
+        self.lr_url = lr_url
+
+
+class Urban100(datasets.GeneratorBasedBuilder):
+    """Urban100 dataset for single image super resolution evaluation."""
+
+    BUILDER_CONFIGS = [
+        Urban100Config(
+            name=key,
+            hr_url=values['hr'],
+            lr_url=values['lr']
+        ) 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."""
+        hr_data_dir = dl_manager.download_and_extract(self.config.hr_url)
+        lr_data_dir = dl_manager.download_and_extract(self.config.lr_url)
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "lr_path": lr_data_dir,
+                    "hr_path": str(Path(hr_data_dir) / 'Urban100_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())
+                }

data/Urban100_HR.tar.gz

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

data/Urban100_LR_x2.tar.gz

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

data/Urban100_LR_x3.tar.gz

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

data/Urban100_LR_x4.tar.gz

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