cats-image.py

# coding=utf-8
# Copyright 2022 The HuggingFace Team.
#
# 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.


import textwrap

import datasets

from PIL import Image


_CITATION = """\\n"""

_DESCRIPTION = """\\n"""


class CatsImageConfig(datasets.BuilderConfig):
    """BuilderConfig for COCO cats image."""

    def __init__(
        self,
        data_url,
        url,
        task_templates=None,
        **kwargs,
    ):
        super(CatsImageConfig, self).__init__(
            version=datasets.Version("1.9.0", ""), **kwargs
        )
        self.data_url = data_url
        self.url = url
        self.task_templates = task_templates


class CatsImage(datasets.GeneratorBasedBuilder):
    """Cats image. You know, THE cats image from the COCO dataset."""

    BUILDER_CONFIGS = [
        CatsImageConfig(
            name="image",
            description=textwrap.dedent(""),
            url="",
            data_url="",
        )
    ]

    DEFAULT_CONFIG_NAME = "image"

    def _info(self):
        return datasets.DatasetInfo(
            description=_DESCRIPTION,
            features=datasets.Features(
                {
                    "image": datasets.Image(),
                }
            ),
            supervised_keys=("image",),
            homepage=self.config.url,
            citation=_CITATION,
        )

    def _split_generators(self, dl_manager):
        DL_URLS = [
            f"https://huggingface.co/datasets/huggingface/cats-image/raw/main/{name}"
            for name in ["cats_image.jpeg"]
        ]
        archive_path = dl_manager.download_and_extract(DL_URLS)
        return [
            datasets.SplitGenerator(
                name=datasets.Split.TEST,
                gen_kwargs={"archive_path": archive_path},
            ),
        ]

    def _generate_examples(self, archive_path):
        """Generate examples."""
        for idx, filename in enumerate(archive_path):
            image = Image.open(filename)
            example = {
                "image": image,
            }
            yield idx, example