Create qa_squad.py

qa_squad.py

@@ -0,0 +1,107 @@
+import json
+import datasets
+from datasets.tasks import QuestionAnsweringExtractive
+
+
+logger = datasets.logging.get_logger(__name__)
+_VERSION = "0.0.0"
+_NAME = "qa_squad"
+_DESCRIPTION = """SQuAD with the train/validation/test split used in SQuAD QG"""
+_CITATION = """
+@inproceedings{du-cardie-2018-harvesting,
+    title = "Harvesting Paragraph-level Question-Answer Pairs from {W}ikipedia",
+    author = "Du, Xinya  and
+      Cardie, Claire",
+    booktitle = "Proceedings of the 56th Annual Meeting of the Association for Computational Linguistics (Volume 1: Long Papers)",
+    month = jul,
+    year = "2018",
+    address = "Melbourne, Australia",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/P18-1177",
+    doi = "10.18653/v1/P18-1177",
+    pages = "1907--1917",
+    abstract = "We study the task of generating from Wikipedia articles question-answer pairs that cover content beyond a single sentence. We propose a neural network approach that incorporates coreference knowledge via a novel gating mechanism. As compared to models that only take into account sentence-level information (Heilman and Smith, 2010; Du et al., 2017; Zhou et al., 2017), we find that the linguistic knowledge introduced by the coreference representation aids question generation significantly, producing models that outperform the current state-of-the-art. We apply our system (composed of an answer span extraction system and the passage-level QG system) to the 10,000 top ranking Wikipedia articles and create a corpus of over one million question-answer pairs. We provide qualitative analysis for the this large-scale generated corpus from Wikipedia.",
+}
+"""
+_BASE_URL = "https://huggingface.co/datasets/lmqg/qa_squad/resolve/main/dataset"
+_URLS = {
+    str(datasets.Split.TRAIN): f'{_BASE_URL}/train.json',
+    str(datasets.Split.VALIDATION): f'{_BASE_URL}/dev.json',
+    str(datasets.Split.TEST): f'{_BASE_URL}/test.json'
+}
+
+
+class QASquadConfig(datasets.BuilderConfig):
+    """BuilderConfig"""
+
+    def __init__(self, **kwargs):
+        """BuilderConfig
+        Args:
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super(QASquadConfig, self).__init__(**kwargs)
+
+
+class QASquad(datasets.GeneratorBasedBuilder):
+
+    BUILDER_CONFIGS = [
+        QASquadConfig(name=_NAME, version=datasets.Version(_VERSION), description=_DESCRIPTION),
+    ]
+    
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "id": datasets.Value("string"),
+                    "title": datasets.Value("string"),
+                    "context": datasets.Value("string"),
+                    "question": datasets.Value("string"),
+                    "answers": datasets.features.Sequence(
+                        {
+                            "text": datasets.Value("string"),
+                            "answer_start": datasets.Value("int32"),
+                        }
+                    ),
+                }
+            ),
+            supervised_keys=None,
+            homepage="https://github.com/asahi417/lm-question-generation",
+            task_templates=[
+                QuestionAnsweringExtractive(
+                    question_column="question", context_column="context", answers_column="answers"
+                )
+            ],
+        )
+
+    def _split_generators(self, dl_manager):
+        downloaded_file = dl_manager.download_and_extract(_URLS)
+        return [datasets.SplitGenerator(name=i, gen_kwargs={"filepath": downloaded_file[str(i)]})
+                for i in [datasets.Split.TRAIN, datasets.Split.VALIDATION, datasets.Split.TEST]]
+
+    def _generate_examples(self, filepath):
+        """This function returns the examples in the raw (text) form."""
+        logger.info("generating examples from = %s", filepath)
+        key = 0
+        with open(filepath, encoding="utf-8") as f:
+            squad = json.load(f)
+            for article in squad["data"]:
+                title = article.get("title", "")
+                for paragraph in article["paragraphs"]:
+                    context = paragraph["context"]  # do not strip leading blank spaces GH-2585
+                    for qa in paragraph["qas"]:
+                        answer_starts = [answer["answer_start"] for answer in qa["answers"]]
+                        answers = [answer["text"] for answer in qa["answers"]]
+                        # Features currently used are "context", "question", and "answers".
+                        # Others are extracted here for the ease of future expansions.
+                        yield key, {
+                            "title": title,
+                            "context": context,
+                            "question": qa["question"],
+                            "id": qa["id"],
+                            "answers": {
+                                "answer_start": answer_starts,
+                                "text": answers,
+                            },
+                        }
+                        key += 1