names.py

# 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.
"""Dataset that includes list of Arabic first names with meaning and origin of most names"""


import csv

import datasets

_CITATION = """\
@software{Al-Fetyani_Maha_Processing_Library_2021,
author = {Al-Fetyani, Mohammad},
month = {11},
title = {{Maha Processing Library}},
url = {https://github.com/TRoboto/Maha},
year = {2021}
}
"""

_DESCRIPTION = """\
List of Arabic first names with meaning and origin of most names
"""

_URL = "https://huggingface.co/datasets/TRoboto/names/raw/main/data/names.tsv"


class Names(datasets.GeneratorBasedBuilder):
    """List of Arabic first names with meaning and origin of most names"""

    VERSION = datasets.Version("1.0.1")

    def _info(self):
        return datasets.DatasetInfo(
            description=_DESCRIPTION,
            features=datasets.Features(
                {
                    "name": datasets.Value("string"),
                    "description": datasets.Value("string"),
                    "origin": datasets.Value("string"),
                }
            ),
            citation=_CITATION,
        )

    def _split_generators(self, dl_manager):
        name_path = dl_manager.download_and_extract(_URL)
        return [
            datasets.SplitGenerator(
                name=datasets.Split.TRAIN, gen_kwargs={"filepath": name_path}
            ),
        ]

    def _generate_examples(self, filepath):
        with open(filepath, encoding="utf-8") as f:
            data = csv.reader(f, delimiter="\t")
            next(data, None)  # skip the headers
            for row_id, row in enumerate(data):
                name, description, origin = row
                yield row_id, {
                    "name": name,
                    "description": description,
                    "origin": origin,
                }