Add ElkarHizketak v1.0 dataset (#3780)

* Add ElkarHizketak v1.0 dataset

* Update datasets/elkarhizketak/README.md

Co-authored-by: Quentin Lhoest <[email protected]>

* Update datasets/elkarhizketak/README.md

Add missing sections to the ToC

Co-authored-by: Quentin Lhoest <[email protected]>

* Update dataset information and delete dummy files

* Update dummy files and code for generating examples to return just one example

* Apply suggestions from code review

* Update elkarhizketak.py

* fill empty sections

Co-authored-by: Arantxa Otegi <[email protected]>
Co-authored-by: Quentin Lhoest <[email protected]>
Co-authored-by: Quentin Lhoest <[email protected]>

Commit from https://github.com/huggingface/datasets/commit/cf47649eaed608fb7030f692020a0921e16f23c8

README.md

@@ -0,0 +1,206 @@
+---
+annotations_creators:
+- no-annotation
+language_creators:
+- crowdsourced
+languages:
+- eu
+licenses:
+- cc-by-sa-4-0
+multilinguality:
+- monolingual
+size_categories:
+- 1K<n<10K
+source_datasets:
+- original
+task_categories:
+- question-answering
+- other-dialogue
+task_ids:
+- extractive-qa
+pretty_name: ElkarHizketak
+---
+
+# Dataset Card for ElkarHizketak
+
+## 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)
+    - [Initial Data Collection and Normalization](#initial-data-collection-and-normalization)
+    - [Who are the source language producers?](#who-are-the-source-language-producers)
+  - [Annotations](#annotations)
+    - [Annotation process](#annotation-process)
+    - [Who are the annotators?](#who-are-the-annotators)
+  - [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:** [ElkarHizketak homepage](http://ixa.si.ehu.es/node/12934)
+- **Paper:** [Conversational Question Answering in Low Resource Scenarios: A Dataset and Case Study for Basque](https://aclanthology.org/2020.lrec-1.55/)
+- **Point of Contact:** [Arantxa Otegi](mailto:[email protected])
+
+### Dataset Summary
+
+ElkarHizketak is a low resource conversational Question Answering (QA) dataset in Basque created by Basque speaker volunteers. The dataset contains close to 400 dialogues and more than 1600 question and answers, and its small size presents a realistic low-resource scenario for conversational QA systems. The dataset is built on top of Wikipedia sections about popular people and organizations. The dialogues involve two crowd workers: (1) a student ask questions after reading a small introduction about the person, but without seeing the section text; and (2) a teacher answers the questions selecting a span of text of the section.
+
+### Supported Tasks and Leaderboards
+
+- `extractive-qa`: The dataset can be used to train a model for Conversational Question Answering.
+
+### Languages
+
+The text in the dataset is in Basque.
+
+## Dataset Structure
+
+### Data Instances
+
+An example from the train split:
+```
+{'dialogue_id': 'C_50be3f56f0d04c99a82f1f950baf0c2d',
+ 'wikipedia_page_title': 'Howard Becker',
+ 'background': 'Howard Saul Becker (Chicago,Illinois, 1928ko apirilaren 18an) Estatu Batuetako soziologoa bat da. Bere ekarpen handienak desbiderakuntzaren soziologian, artearen soziologian eta musikaren soziologian egin ditu. "Outsiders" (1963) bere lanik garrantzitsuetako da eta bertan garatu zuen bere etiketatze-teoria. Nahiz eta elkarrekintza sinbolikoaren edo gizarte-konstruktibismoaren korronteen barruan sartu izan, berak ez du bere burua inongo paradigman kokatzen. Chicagoko Unibertsitatean graduatua, Becker Chicagoko Soziologia Eskolako bigarren belaunaldiaren barruan kokatu ohi da, Erving Goffman eta Anselm Strauss-ekin batera.',
+ 'section_title': 'Hastapenak eta hezkuntza.',
+ 'context': 'Howard Saul Becker Chicagon jaio zen 1928ko apirilaren 18an. Oso gazte zelarik piano jotzen asi zen eta 15 urte zituenean dagoeneko tabernetan aritzen zen pianoa jotzen. Beranduago Northwestern Unibertsitateko banda batean jo zuen. Beckerren arabera, erdi-profesional gisa aritu ahal izan zen Bigarren Mundu Gerra tokatu eta musikari gehienak soldadugai zeudelako. Musikari bezala egin zuen lan horretan egin zuen lehen aldiz drogaren kulturaren ezagutza, aurrerago ikerketa-gai hartuko zuena. 1946an bere graduazpiko soziologia titulua lortu zuen Chicagoko Unibertsitatean. Ikasten ari zen bitartean, pianoa jotzen jarraitu zuen modu erdi-profesionalean. Hala ere, soziologiako masterra eta doktoretza eskuratu zituen Chicagoko Unibertsitatean. Unibertsitate horretan Chicagoko Soziologia Eskolaren jatorrizko tradizioaren barruan hezia izan zen. Chicagoko Soziologia Eskolak garrantzi berezia ematen zion datu kualitatiboen analisiari eta Chicagoko hiria hartzen zuen ikerketa eremu bezala. Beckerren hasierako lan askok eskola honen tradizioaren eragina dute, bereziko Everett C. Hughes-en eragina, bere tutore eta gidari izan zena. Askotan elkarrekintzaile sinboliko bezala izendatua izan da, nahiz eta Beckerek berak ez duen gogoko izendapen hori. Haren arabera, bere leinu akademikoa Georg Simmel, Robert E. Park eta Everett Hughes dira. Doktoretza lortu ostean, 23 urterekin, Beckerrek marihuanaren erabilpena ikertu zuen "Institut for Juvenil Reseac"h-en. Ondoren Illinoisko Unibertsitatean eta Standfor Unibertsitateko ikerketa institutu batean aritu zen bere irakasle karrera hasi aurretik. CANNOTANSWER',
+ 'turn_id': 'C_50be3f56f0d04c99a82f1f950baf0c2d_q#0',
+ 'question': 'Zer da desbiderakuntzaren soziologia?',
+ 'yesno': 2,
+ 'answers': {'text': ['CANNOTANSWER'],
+  'answer_start': [1601],
+  'input_text': ['CANNOTANSWER']},
+ 'orig_answer': {'text': 'CANNOTANSWER', 'answer_start': 1601}}
+ ```
+
+### Data Fields
+
+The different fields are:
+
+- `dialogue_id`: string,
+- `wikipedia_page_title`: title of the wikipedia page as a string,
+- `background`: string,
+- `section_title`: title os the section as a string,
+- `context`: context of the question as a string string,
+- `turn_id`: string,
+- `question`: question as a string,
+- `yesno`: Class label that represents if the question is a yes/no question. Possible values are "y" (0), "n" (1), "x" (2),
+- `answers`: a dictionary with three fields:
+  - `text`: list of texts of the answer as a string,
+  - `answer_start`: list of positions of the answers in the context as an int32,
+  - `input_text`: list of strings,
+    }
+),
+- `orig_answer`: {
+  - `text`: original answer text as a string,
+  - `answer_start`: original position of the answer as an int32,
+},
+
+### Data Splits
+
+The data is split into a training, development and test set. The split sizes are as follow:
+
+- train: 1,306 questions / 301 dialogues
+- development:  161 questions / 38 dialogues
+- test: 167 questions / 38 dialogues
+
+## Dataset Creation
+
+### Curation Rationale
+
+This is the first non-English conversational QA dataset and the first conversational dataset for Basque. Its small size presents a realistic low-resource scenario for conversational QA systems.
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+First we selected sections of Wikipedia articles about people, as less specialized knowledge is required to converse about people than other categories. In order to retrieve articles we selected the following categories in Basque Wikipedia: Biografia (Biography is the equivalent category in English Wikipedia), Biografiak (People) and Gizabanako biziak (Living people). We applied this category filter and downloaded the articles using a querying tool provided by the Wikimedia foundation. Once we retrieved the articles, we selected sections from them that contained between 175 and 300 words. These filters and threshold were set after some pilot studies where we check the adequacy of the people involved in the selected articles and the length of the passages in order to have enough but not to much information to hold a conversation.
+
+Then, dialogues were collected during some online sessions that we arranged with Basque speaking volunteers. The dialogues involve two crowd workers: (1) a student ask questions after reading a small introduction about the person, but without seeing the section text; and (2) a teacher answers the questions selecting a span of text of the section.
+
+#### Who are the source language producers?
+
+The language producers are Basque speaking volunteers which hold a conversation using a text-based chat interface developed for those purposes.
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### 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
+
+The dataset was created by Arantxa Otegi, Jon Ander Campos, Aitor Soroa and Eneko Agirre from the [HiTZ Basque Center for Language Technologies](https://www.hitz.eus/) and [Ixa NLP Group](https://www.ixa.eus/) at the University of the Basque Country (UPV/EHU).
+
+### Licensing Information
+
+Copyright (C) by Ixa Taldea, University of the Basque Country UPV/EHU.
+
+This dataset is licensed under the Creative Commons Attribution-ShareAlike 4.0 International Public License (CC BY-SA 4.0).
+To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/legalcode](https://creativecommons.org/licenses/by-sa/4.0/legalcode).
+
+### Citation Information
+
+If you are using this dataset in your work, please cite this publication:
+
+```bibtex
+@inproceedings{otegi-etal-2020-conversational,
+    title = "{Conversational Question Answering in Low Resource Scenarios: A Dataset and Case Study for Basque}",
+    author = "Otegi, Arantxa  and
+      Agirre, Aitor  and
+      Campos, Jon Ander  and
+      Soroa, Aitor  and
+      Agirre, Eneko",
+    booktitle = "Proceedings of the 12th Language Resources and Evaluation Conference",
+    year = "2020",
+    address = "Marseille, France",
+    publisher = "European Language Resources Association",
+    url = "https://aclanthology.org/2020.lrec-1.55",
+    pages = "436--442"
+}
+```
+
+### Contributions
+
+Thanks to [@antxa](https://github.com/antxa) for adding this dataset.

dataset_infos.json

@@ -0,0 +1 @@
+{"plain_text": {"description": "\nElkarHizketak is a low resource conversational Question Answering\n(QA) dataset in Basque created by Basque speaker volunteers. The\ndataset contains close to 400 dialogues and more than 1600 question\nand answers, and its small size presents a realistic low-resource\nscenario for conversational QA systems. The dataset is built on top of\nWikipedia sections about popular people and organizations. The\ndialogues involve two crowd workers: (1) a student ask questions after\nreading a small introduction about the person, but without seeing the\nsection text; and (2) a teacher answers the questions selecting a span\nof text of the section.  ", "citation": "@inproceedings{otegi-etal-2020-conversational,\n    title = \"{Conversational Question Answering in Low Resource Scenarios: A Dataset and Case Study for {B}asque}\",\n    author = \"Otegi, Arantxa  and\n      Agirre, Aitor  and\n      Campos, Jon Ander  and\n      Soroa, Aitor  and\n      Agirre, Eneko\",\n    booktitle = \"Proceedings of the 12th Language Resources and Evaluation Conference\",\n    year = \"2020\",\n    publisher = \"European Language Resources Association\",\n    url = \"https://aclanthology.org/2020.lrec-1.55\",\n    pages = \"436--442\",\n    ISBN = \"979-10-95546-34-4\",\n}\n", "homepage": "http://ixa.si.ehu.es/node/12934", "license": "Creative Commons Attribution-ShareAlike 4.0 International Public License (CC BY-SA 4.0)", "features": {"dialogue_id": {"dtype": "string", "id": null, "_type": "Value"}, "wikipedia_page_title": {"dtype": "string", "id": null, "_type": "Value"}, "background": {"dtype": "string", "id": null, "_type": "Value"}, "section_title": {"dtype": "string", "id": null, "_type": "Value"}, "context": {"dtype": "string", "id": null, "_type": "Value"}, "turn_ids": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "questions": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "yesnos": {"feature": {"num_classes": 3, "names": ["y", "n", "x"], "id": null, "_type": "ClassLabel"}, "length": -1, "id": null, "_type": "Sequence"}, "answers": {"feature": {"texts": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "answer_starts": {"feature": {"dtype": "int32", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "input_texts": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}}, "length": -1, "id": null, "_type": "Sequence"}, "orig_answers": {"texts": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "answer_starts": {"feature": {"dtype": "int32", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "elkarhizketak", "config_name": "plain_text", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 1024378, "num_examples": 301, "dataset_name": "elkarhizketak"}, "validation": {"name": "validation", "num_bytes": 125667, "num_examples": 38, "dataset_name": "elkarhizketak"}, "test": {"name": "test", "num_bytes": 127640, "num_examples": 38, "dataset_name": "elkarhizketak"}}, "download_checksums": {"http://ixa2.si.ehu.es/convai/elkarhizketak-v1.0/elkarhizketak-train-v1.0.json": {"num_bytes": 1543845, "checksum": "36674936820c9a5d8a5de144776dd57e2e4f5f63eec6ac45f93e47e5fd9daecd"}, "http://ixa2.si.ehu.es/convai/elkarhizketak-v1.0/elkarhizketak-dev-v1.0.json": {"num_bytes": 189736, "checksum": "fbf2e14b63de9a8406a9b44dccd0e2c4dcdf07724af737ccd05e06311a632f57"}, "http://ixa2.si.ehu.es/convai/elkarhizketak-v1.0/elkarhizketak-test-v1.0.json": {"num_bytes": 193893, "checksum": "311154feb69ede265ed695f97ab81811d78d837572114396b6e8779fdeb3e3f0"}}, "download_size": 1927474, "post_processing_size": null, "dataset_size": 1277685, "size_in_bytes": 3205159}}

dummy/plain_text/1.0.0/dummy_data.zip

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

elkarhizketak.py

@@ -0,0 +1,171 @@
+# 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.
+
+"""ElkarHizketak: Conversational Question Answering dataset in Basque"""
+
+import json
+
+import datasets
+
+
+logger = datasets.logging.get_logger(__name__)
+
+
+_CITATION = """\
+@inproceedings{otegi-etal-2020-conversational,
+    title = "{Conversational Question Answering in Low Resource Scenarios: A Dataset and Case Study for {B}asque}",
+    author = "Otegi, Arantxa  and
+      Agirre, Aitor  and
+      Campos, Jon Ander  and
+      Soroa, Aitor  and
+      Agirre, Eneko",
+    booktitle = "Proceedings of the 12th Language Resources and Evaluation Conference",
+    year = "2020",
+    publisher = "European Language Resources Association",
+    url = "https://aclanthology.org/2020.lrec-1.55",
+    pages = "436--442",
+    ISBN = "979-10-95546-34-4",
+}
+"""
+
+_DESCRIPTION = """
+ElkarHizketak is a low resource conversational Question Answering
+(QA) dataset in Basque created by Basque speaker volunteers. The
+dataset contains close to 400 dialogues and more than 1600 question
+and answers, and its small size presents a realistic low-resource
+scenario for conversational QA systems. The dataset is built on top of
+Wikipedia sections about popular people and organizations. The
+dialogues involve two crowd workers: (1) a student ask questions after
+reading a small introduction about the person, but without seeing the
+section text; and (2) a teacher answers the questions selecting a span
+of text of the section.  """
+
+_HOMEPAGE = "http://ixa.si.ehu.es/node/12934"
+
+_LICENSE = "Creative Commons Attribution-ShareAlike 4.0 International Public License (CC BY-SA 4.0)"
+
+_URLs = {
+    "train": "http://ixa2.si.ehu.es/convai/elkarhizketak-v1.0/elkarhizketak-train-v1.0.json",
+    "validation": "http://ixa2.si.ehu.es/convai/elkarhizketak-v1.0/elkarhizketak-dev-v1.0.json",
+    "test": "http://ixa2.si.ehu.es/convai/elkarhizketak-v1.0/elkarhizketak-test-v1.0.json",
+}
+
+
+class Elkarhizketak(datasets.GeneratorBasedBuilder):
+    """ElkarHizketak: Conversational Question Answering dataset in Basque. Version 1.0."""
+
+    VERSION = datasets.Version("1.0.0")
+
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(
+            name="plain_text",
+            description="Plain text",
+            version=VERSION,
+        ),
+    ]
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "dialogue_id": datasets.Value("string"),
+                    "wikipedia_page_title": datasets.Value("string"),
+                    "background": datasets.Value("string"),
+                    "section_title": datasets.Value("string"),
+                    "context": datasets.Value("string"),
+                    "turn_id": datasets.Value("string"),
+                    "question": datasets.Value("string"),
+                    "yesno": datasets.ClassLabel(names=["y", "n", "x"]),
+                    "answers": datasets.Sequence(
+                        {
+                            "text": datasets.Value("string"),
+                            "answer_start": datasets.Value("int32"),
+                            "input_text": datasets.Value("string"),
+                        }
+                    ),
+                    "orig_answer": {
+                        "text": datasets.Value("string"),
+                        "answer_start": datasets.Value("int32"),
+                    },
+                }
+            ),
+            supervised_keys=None,
+            homepage=_HOMEPAGE,
+            license=_LICENSE,
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        data_dir = dl_manager.download_and_extract(_URLs)
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={
+                    "filepath": data_dir["train"],
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                gen_kwargs={
+                    "filepath": data_dir["validation"],
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                gen_kwargs={
+                    "filepath": data_dir["test"],
+                },
+            ),
+        ]
+
+    def _generate_examples(self, filepath):
+        """Yields examples."""
+        logger.info("generating examples from = %s", filepath)
+
+        key = 0
+        with open(filepath, encoding="utf-8") as f:
+            elkarhizketak = json.load(f)
+            for section in elkarhizketak["data"]:
+                wiki_page_title = section.get("title", "").strip()
+                background = section.get("background", "").strip()
+                section_title = section.get("section_title", "").strip()
+                for dialogue in section["paragraphs"]:
+                    context = dialogue["context"].strip()
+                    dialogue_id = dialogue["id"]
+                    for qa in dialogue["qas"]:
+                        answer_starts = [answer["answer_start"] for answer in qa["answers"]]
+                        answers = [answer["text"].strip() for answer in qa["answers"]]
+                        input_texts = [answer["input_text"].strip() for answer in qa["answers"]]
+                        yield key, {
+                            "wikipedia_page_title": wiki_page_title,
+                            "background": background,
+                            "section_title": section_title,
+                            "context": context,
+                            "dialogue_id": dialogue_id,
+                            "question": qa["question"],
+                            "turn_id": qa["id"],
+                            "yesno": qa["yesno"],
+                            "answers": {
+                                "answer_start": answer_starts,
+                                "text": answers,
+                                "input_text": input_texts,
+                            },
+                            "orig_answer": {
+                                "answer_start": qa["orig_answer"]["answer_start"],
+                                "text": qa["orig_answer"]["text"],
+                            },
+                        }
+                        key += 1