Upload 2 files

README.md

@@ -1,3 +1,261 @@
 ---
-license: afl-3.0
----
+annotations_creators:
+- expert-generated
+language:
+- bm
+- bbj
+- ee
+- fon
+- ha
+- ig
+- rw
+- lg
+- luo
+- mos
+- ny
+- pcm
+- sn
+- sw
+- tn
+- tw
+- wo
+- xh
+- yo
+- zu
+language_creators:
+- expert-generated
+license:
+- afl-3.0
+multilinguality:
+- multilingual
+pretty_name: masakhaner2.0
+size_categories:
+- 1K<n<10K
+source_datasets:
+- original
+tags:
+- ner
+- masakhaner
+- masakhane
+task_categories:
+- token-classification
+task_ids:
+- named-entity-recognition---
+
+# Dataset Card for [Dataset Name]
+
+## 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:** [homepage](https://github.com/masakhane-io/masakhane-ner)
+- **Repository:** [github](https://github.com/masakhane-io/masakhane-ner)
+- **Paper:** [paper](https://arxiv.org/abs/2103.11811)
+- **Point of Contact:** [Masakhane](https://www.masakhane.io/) or didelani@lsv.uni-saarland.de
+
+### Dataset Summary
+
+MasakhaNER 2.0 is the largest publicly available high-quality dataset for named entity recognition (NER) in 20 African languages created by the Masakhane community.
+
+Named entities are phrases that contain the names of persons, organizations, locations, times and quantities. Example:
+
+[PER Wolff] , currently a journalist in [LOC Argentina] , played with [PER Del Bosque] in the final years of the seventies in [ORG Real Madrid] .
+
+MasakhaNER 2.0 is a named entity dataset consisting of PER, ORG, LOC, and DATE entities annotated by Masakhane for 20 African languages
+
+The train/validation/test sets are available for all the ten languages.
+
+For more details see https://arxiv.org/abs/2103.11811
+
+
+### Supported Tasks and Leaderboards
+
+[More Information Needed]
+
+- `named-entity-recognition`: The performance in this task is measured with [F1](https://huggingface.co/metrics/f1) (higher is better). A named entity is correct only if it is an exact match of the corresponding entity in the data.
+
+### Languages
+
+There are 20 languages available :
+- Bambara (bam)
+- Ghomala (bbj)
+- Ewe (ewe)
+- Fon (fon)
+- Hausa (hau)
+- Igbo (ibo)
+- Kinyarwanda (kin)
+- Luganda (lug)
+- Dholuo (luo) 
+- Mossi (mos)
+- Chichewa (nya)
+- Nigerian Pidgin
+- chShona (sna)
+- Kiswahili (swą)
+- Setswana (tsn)
+- Twi (twi)
+- Wolof (wol)
+- isiXhosa (xho)
+- Yorùbá (yor)
+- isiZulu (zul)
+
+## Dataset Structure
+
+### Data Instances
+
+The examples look like this for Yorùbá:
+
+```
+from datasets import load_dataset
+data = load_dataset('masakhaner', 'yor') 
+
+# Please, specify the language code
+
+# A data point consists of sentences seperated by empty line and tab-seperated tokens and tags. 
+{'id': '0',
+ 'ner_tags': [B-DATE, I-DATE, 0, 0, 0, 0, 0, B-PER, I-PER, I-PER, O, O, O, O],
+ 'tokens': ['Wákàtí', 'méje', 'ti', 'ré', 'kọjá', 'lọ', 'tí', 'Luis', 'Carlos', 'Díaz', 'ti', 'di', 'awati', '.']
+}
+```
+
+### Data Fields
+
+- `id`: id of the sample
+- `tokens`: the tokens of the example text
+- `ner_tags`: the NER tags of each token
+
+The NER tags correspond to this list:
+```
+"O", "B-PER", "I-PER", "B-ORG", "I-ORG", "B-LOC", "I-LOC", "B-DATE", "I-DATE",
+```
+
+In the NER tags, a B denotes the first item of a phrase and an I any non-initial word. There are four types of phrases: person names (PER), organizations (ORG), locations (LOC) and dates & time (DATE).
+
+It is assumed that named entities are non-recursive and non-overlapping. In case a named entity is embedded in another named entity usually, only the top level entity is marked.
+
+### Data Splits
+
+For all languages, there are three splits.
+
+The original splits were named `train`, `dev` and `test` and they correspond to the `train`, `validation` and `test` splits.
+
+The splits have the following sizes :
+
+| Language        | train | validation | test  |
+|-----------------|------:|-----------:|------:|
+| Bambara         |  4463 |        638 |  1274 |
+| Ghomala         |  3384 |        483 |   966 |
+| Ewe             |  3505 |        501 |  1001 |
+| Fon.            |  4343 |        621 |  1240 |
+| Hausa           |  5716 |        816 |  1633 |
+| Igbo            |  7634 |       1090 |  2181 |
+| Kinyarwanda     |  7825 |       1118 |  2235 |
+| Luganda         |  4942 |        706 |  1412 |
+| Luo             |  5161 |        737 |  1474 |
+| Mossi           |  4532 |        648 |  1613 |
+| Nigerian-Pidgin |  5646 |        806 |  1294 |
+| Chichewa        |  6250 |        893 |  1785 |
+| chiShona        |  6207 |        887 |  1773 |
+| Kiswahili       |  6593 |        942 |  1883 |
+| Setswana        |  3289 |        499 |   996 |
+| Akan/Twi        |  4240 |        605 |  1211 |
+| Wolof           |  4593 |        656 |  1312 |
+| isiXhosa        |  5718 |        817 |  1633 |
+| Yoruba          |  6877 |        983 |  1964 |
+| isiZulu         |  5848 |        836 |  1670 |
+
+## Dataset Creation
+
+### Curation Rationale
+
+The dataset was introduced to introduce new resources to ten languages that were under-served for natural language processing.
+
+[More Information Needed]
+
+### Source Data
+
+The source of the data is from the news domain, details can be found here https://arxiv.org/abs/2103.11811
+
+#### Initial Data Collection and Normalization
+
+The articles were word-tokenized, information on the exact pre-processing pipeline is unavailable.
+
+#### Who are the source language producers?
+
+The source language was produced by journalists and writers employed by the news agency and newspaper mentioned above.
+
+### Annotations
+
+#### Annotation process
+
+Details can be found here https://arxiv.org/abs/2103.11811
+
+#### Who are the annotators?
+
+Annotators were recruited from [Masakhane](https://www.masakhane.io/)
+
+### Personal and Sensitive Information
+
+The data is sourced from newspaper source and only contains mentions of public figures or individuals
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+[More Information Needed]
+
+
+### Discussion of Biases
+[More Information Needed]
+
+
+### Other Known Limitations
+
+Users should keep in mind that the dataset only contains news text, which might limit the applicability of the developed systems to other domains.
+
+## Additional Information
+
+### Dataset Curators
+
+
+### Licensing Information
+
+The licensing status of the data is CC 4.0 Non-Commercial
+
+### Citation Information
+
+Provide the [BibTex](http://www.bibtex.org/)-formatted reference for the dataset. For example:
+```
+@article{Adelani2022MasakhaNER2A,
+  title={MasakhaNER 2.0: Africa-centric Transfer Learning for Named Entity Recognition},
+  author={David Ifeoluwa Adelani and Graham Neubig and Sebastian Ruder and Shruti Rijhwani and Michael Beukman and Chester Palen-Michel and Constantine Lignos and Jesujoba Oluwadara Alabi and Shamsuddeen Hassan Muhammad and Peter Nabende and Cheikh M. Bamba Dione and Andiswa Bukula and Rooweither Mabuya and Bonaventure F. P. Dossou and Blessing K. Sibanda and Happy Buzaaba and Jonathan Mukiibi and Godson Kalipe and Derguene Mbaye and Amelia Taylor and Fatoumata Kabore and Chris C. Emezue and Anuoluwapo Aremu and Perez Ogayo and Catherine W. Gitau and Edwin Munkoh-Buabeng and Victoire Memdjokam Koagne and Allahsera Auguste Tapo and Tebogo Macucwa and Vukosi Marivate and Elvis Mboning and Tajuddeen R. Gwadabe and Tosin P. Adewumi and Orevaoghene Ahia and Joyce Nakatumba-Nabende and Neo L. Mokono and Ignatius M Ezeani and Chiamaka Ijeoma Chukwuneke and Mofetoluwa Adeyemi and Gilles Hacheme and Idris Abdulmumin and Odunayo Ogundepo and Oreen Yousuf and Tatiana Moteu Ngoli and Dietrich Klakow},
+  journal={ArXiv},
+  year={2022},
+  volume={abs/2210.12391}
+}
+```
+
+### Contributions
+
+Thanks to [@dadelani](https://github.com/dadelani) for adding this dataset.

masakhaner2.py

@@ -0,0 +1,186 @@
+# coding=utf-8
+# Copyright 2020 HuggingFace Datasets Authors.
+#
+# 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.
+
+# Lint as: python3
+"""MasakhaNER: Named Entity Recognition for African Languages"""
+
+import datasets
+
+
+logger = datasets.logging.get_logger(__name__)
+
+
+_CITATION = """\
+@article{Adelani2022MasakhaNER2A,
+  title={MasakhaNER 2.0: Africa-centric Transfer Learning for Named Entity Recognition},
+  author={David Ifeoluwa Adelani and Graham Neubig and Sebastian Ruder and Shruti Rijhwani and Michael Beukman and Chester Palen-Michel and Constantine Lignos and Jesujoba Oluwadara Alabi and Shamsuddeen Hassan Muhammad and Peter Nabende and Cheikh M. Bamba Dione and Andiswa Bukula and Rooweither Mabuya and Bonaventure F. P. Dossou and Blessing K. Sibanda and Happy Buzaaba and Jonathan Mukiibi and Godson Kalipe and Derguene Mbaye and Amelia Taylor and Fatoumata Kabore and Chris C. Emezue and Anuoluwapo Aremu and Perez Ogayo and Catherine W. Gitau and Edwin Munkoh-Buabeng and Victoire Memdjokam Koagne and Allahsera Auguste Tapo and Tebogo Macucwa and Vukosi Marivate and Elvis Mboning and Tajuddeen R. Gwadabe and Tosin P. Adewumi and Orevaoghene Ahia and Joyce Nakatumba-Nabende and Neo L. Mokono and Ignatius M Ezeani and Chiamaka Ijeoma Chukwuneke and Mofetoluwa Adeyemi and Gilles Hacheme and Idris Abdulmumin and Odunayo Ogundepo and Oreen Yousuf and Tatiana Moteu Ngoli and Dietrich Klakow},
+  journal={ArXiv},
+  year={2022},
+  volume={abs/2210.12391}
+}
+"""
+
+_DESCRIPTION = """\
+MasakhaNER 2.0 is the largest publicly available high-quality dataset for named entity recognition (NER) in 20 African languages.
+
+Named entities are phrases that contain the names of persons, organizations, locations, times and quantities.
+
+Example:
+[PER Wolff] , currently a journalist in [LOC Argentina] , played with [PER Del Bosque] in the final years of the seventies in [ORG Real Madrid] .
+MasakhaNER is a named entity dataset consisting of PER, ORG, LOC, and DATE entities annotated by Masakhane for 20 African languages:
+- Bambara (bam)
+- Ghomala (bbj)
+- Ewe (ewe)
+- Fon (fon)
+- Hausa (hau)
+- Igbo (ibo)
+- Kinyarwanda (kin)
+- Luganda (lug)
+- Dholuo (luo) 
+- Mossi (mos)
+- Chichewa (nya)
+- Nigerian Pidgin
+- chShona (sna)
+- Kiswahili (swą)
+- Setswana (tsn)
+- Twi (twi)
+- Wolof (wol)
+- isiXhosa (xho)
+- Yorùbá (yor)
+- isiZulu (zul)
+
+The train/validation/test sets are available for all the ten languages.
+
+For more details see https://arxiv.org/abs/2103.11811
+"""
+
+_URL = "https://github.com/masakhane-io/masakhane-ner/raw/main/MasakhaNER2.0/data/"
+_TRAINING_FILE = "train.txt"
+_DEV_FILE = "dev.txt"
+_TEST_FILE = "test.txt"
+
+
+class MasakhanerConfig(datasets.BuilderConfig):
+    """BuilderConfig for Masakhaner"""
+
+    def __init__(self, **kwargs):
+        """BuilderConfig for Masakhaner.
+
+        Args:
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super(MasakhanerConfig, self).__init__(**kwargs)
+
+
+class Masakhaner(datasets.GeneratorBasedBuilder):
+    """Masakhaner dataset."""
+
+    BUILDER_CONFIGS = [
+        MasakhanerConfig(name="bam", version=datasets.Version("1.0.0"), description="Masakhaner Bambara dataset"),
+        MasakhanerConfig(name="bbj", version=datasets.Version("1.0.0"), description="Masakhaner Ghomala dataset"),
+        MasakhanerConfig(name="ewe", version=datasets.Version("1.0.0"), description="Masakhaner Ewe dataset"),
+        MasakhanerConfig(name="fon", version=datasets.Version("1.0.0"), description="Masakhaner Fon dataset"),
+        MasakhanerConfig(name="hau", version=datasets.Version("1.0.0"), description="Masakhaner Hausa dataset"),
+        MasakhanerConfig(name="ibo", version=datasets.Version("1.0.0"), description="Masakhaner Igbo dataset"),
+        MasakhanerConfig(name="kin", version=datasets.Version("1.0.0"), description="Masakhaner Kinyarwanda dataset"),
+        MasakhanerConfig(name="lug", version=datasets.Version("1.0.0"), description="Masakhaner Luganda dataset"),
+        MasakhanerConfig(name="mos", version=datasets.Version("1.0.0"), description="Masakhaner Mossi dataset"),
+        MasakhanerConfig(name="nya", version=datasets.Version("1.0.0"), description="Masakhaner Chichewa` dataset"),
+        MasakhanerConfig(
+            name="pcm", version=datasets.Version("1.0.0"), description="Masakhaner Nigerian-Pidgin dataset"
+        ),
+        MasakhanerConfig(name="sna", version=datasets.Version("1.0.0"), description="Masakhaner Shona dataset"),
+        MasakhanerConfig(name="swa", version=datasets.Version("1.0.0"), description="Masakhaner Swahili dataset"),
+        MasakhanerConfig(name="tsn", version=datasets.Version("1.0.0"), description="Masakhaner Setswana dataset"),
+        MasakhanerConfig(name="twi", version=datasets.Version("1.0.0"), description="Masakhaner Twi dataset"),
+        MasakhanerConfig(name="wol", version=datasets.Version("1.0.0"), description="Masakhaner Wolof dataset"),
+        MasakhanerConfig(name="xho", version=datasets.Version("1.0.0"), description="Masakhaner Xhosa dataset"),
+        MasakhanerConfig(name="yor", version=datasets.Version("1.0.0"), description="Masakhaner Yoruba dataset"),
+        MasakhanerConfig(name="zul", version=datasets.Version("1.0.0"), description="Masakhaner Zulu dataset"),
+    ]
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "id": datasets.Value("string"),
+                    "tokens": datasets.Sequence(datasets.Value("string")),
+                    "ner_tags": datasets.Sequence(
+                        datasets.features.ClassLabel(
+                            names=[
+                                "O",
+                                "B-PER",
+                                "I-PER",
+                                "B-ORG",
+                                "I-ORG",
+                                "B-LOC",
+                                "I-LOC",
+                                "B-DATE",
+                                "I-DATE",
+                            ]
+                        )
+                    ),
+                }
+            ),
+            supervised_keys=None,
+            homepage="https://arxiv.org/abs/2210.12391",
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        urls_to_download = {
+            "train": f"{_URL}{self.config.name}/{_TRAINING_FILE}",
+            "dev": f"{_URL}{self.config.name}/{_DEV_FILE}",
+            "test": f"{_URL}{self.config.name}/{_TEST_FILE}",
+        }
+        downloaded_files = dl_manager.download_and_extract(urls_to_download)
+
+        return [
+            datasets.SplitGenerator(name=datasets.Split.TRAIN, gen_kwargs={"filepath": downloaded_files["train"]}),
+            datasets.SplitGenerator(name=datasets.Split.VALIDATION, gen_kwargs={"filepath": downloaded_files["dev"]}),
+            datasets.SplitGenerator(name=datasets.Split.TEST, gen_kwargs={"filepath": downloaded_files["test"]}),
+        ]
+
+    def _generate_examples(self, filepath):
+        logger.info("⏳ Generating examples from = %s", filepath)
+        with open(filepath, encoding="utf-8") as f:
+            guid = 0
+            tokens = []
+            ner_tags = []
+            for line in f:
+                if line == "" or line == "\n":
+                    if tokens:
+                        yield guid, {
+                            "id": str(guid),
+                            "tokens": tokens,
+                            "ner_tags": ner_tags,
+                        }
+                        guid += 1
+                        tokens = []
+                        ner_tags = []
+                else:
+                    # Masakhaner tokens are space separated
+                    splits = line.split(" ")
+                    tokens.append(splits[0])
+                    ner_tags.append(splits[1].rstrip())
+            # last example
+            if tokens:
+                yield guid, {
+                    "id": str(guid),
+                    "tokens": tokens,
+                    "ner_tags": ner_tags,
+                }