Update files from the datasets library (from 1.3.0)

Release notes: https://github.com/huggingface/datasets/releases/tag/1.3.0

.gitattributes

@@ -0,0 +1,27 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bin.* filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zstandard filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,199 @@
+---
+annotations_creators:
+- crowdsourced
+language_creators:
+- found
+languages:
+- en
+licenses:
+- apache-2-0
+multilinguality:
+- monolingual
+size_categories:
+- 10K<n<100K
+source_datasets:
+- original
+task_categories:
+- question-answering
+task_ids:
+- abstractive-qa
+---
+
+# Dataset Card for Narrative QA Manual
+
+## Table of Contents
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks](#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:** [NarrativeQA Homepage](https://deepmind.com/research/open-source/narrativeqa)
+- **Repository:** [NarrativeQA Repo](https://github.com/deepmind/narrativeqa)
+- **Paper:** [The NarrativeQA Reading Comprehension Challenge](https://arxiv.org/pdf/1712.07040.pdf)
+- **Leaderboard:**
+- **Point of Contact:** [Tomáš Kočiský](mailto:tkocisky@google.com) [Jonathan Schwarz](mailto:schwarzjn@google.com) [Phil Blunsom](pblunsom@google.com) [Chris Dyer](cdyer@google.com) [Karl Moritz Hermann](mailto:kmh@google.com) [Gábor Melis](mailto:melisgl@google.com) [Edward Grefenstette](mailto:etg@google.com)
+
+### Dataset Summary
+
+NarrativeQA Manual is an English-language dataset of stories and corresponding questions designed to test reading comprehension, especially on long documents. THIS DATASET REQUIRES A MANUALLY DOWNLOADED FILE! Because of a script in the original repository which downloads the stories from original URLs everytime, the links are sometimes broken or invalid. Therefore, you need to manually download the stories for this dataset using the script provided by the authors (https://github.com/deepmind/narrativeqa/blob/master/download_stories.sh). Running the shell script creates a folder named "tmp" in the root directory and downloads the stories there. This folder containing the stories can be used to load the dataset via `datasets.load_dataset("narrativeqa_manual", data_dir="<path/to/folder>")`.
+
+### Supported Tasks and Leaderboards
+
+The dataset is used to test reading comprehension. There are 2 tasks proposed in the paper: "summaries only" and "stories only", depending on whether the human-generated summary or the full story text is used to answer the question.
+
+### Languages
+
+English
+
+## Dataset Structure
+
+### Data Instances
+
+A typical data point consists of a question and answer pair along with a summary/story which can be used to answer the question. Additional information such as the url, word count, wikipedia page, are also provided.
+
+A typical example looks like this:
+```
+{
+    "document": {
+        "id": "23jncj2n3534563110",
+        "kind": "movie",
+        "url": "https://www.imsdb.com/Movie%20Scripts/Name%20of%20Movie.html",
+        "file_size": 80473,
+        "word_count": 41000,
+        "start": "MOVIE screenplay by",
+        "end": ". THE END",
+        "summary": {
+            "text": "Joe Bloggs begins his journey exploring...",
+            "tokens": ["Joe", "Bloggs", "begins", "his", "journey", "exploring",...],
+            "url": "http://en.wikipedia.org/wiki/Name_of_Movie",
+            "title": "Name of Movie (film)"
+        },
+        "text": "MOVIE screenplay by John Doe\nSCENE 1..."
+    },
+    "question": {
+        "text": "Where does Joe Bloggs live?",
+        "tokens": ["Where", "does", "Joe", "Bloggs", "live", "?"],
+    },
+    "answers": [
+        {"text": "At home", "tokens": ["At", "home"]},
+        {"text": "His house", "tokens": ["His", "house"]}
+    ]
+}
+```
+
+### Data Fields
+
+- `document.id` - Unique ID for the story.
+- `document.kind` - "movie" or "gutenberg" depending on the source of the story.
+- `document.url` - The URL where the story was downloaded from.
+- `document.file_size` - File size (in bytes) of the story.
+- `document.word_count` - Number of tokens in the story.
+- `document.start` - First 3 tokens of the story. Used for verifying the story hasn't been modified.
+- `document.end` - Last 3 tokens of the story. Used for verifying the story hasn't been modified.
+- `document.summary.text` - Text of the wikipedia summary of the story.
+- `document.summary.tokens` - Tokenized version of `document.summary.text`.
+- `document.summary.url` - Wikipedia URL of the summary.
+- `document.summary.title` - Wikipedia Title of the summary.
+- `question` - `{"text":"...", "tokens":[...]}` for the question about the story.
+- `answers` - List of `{"text":"...", "tokens":[...]}` for valid answers for the question.
+
+### Data Splits
+
+The data is split into training, valiudation, and test sets based on story (i.e. the same story cannot appear in more than one split):
+
+| Train  | Valid | Test  |
+| ------ | ----- | ----- |
+| 32747  | 3461  | 10557 |
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+Stories and movies scripts were downloaded from [Project Gutenburg](https://www.gutenberg.org) and a range of movie script repositories (mainly [imsdb](http://www.imsdb.com)).
+
+#### Who are the source language producers?
+
+The language producers are authors of the stories and scripts as well as Amazon Turk workers for the questions.
+
+### Annotations
+
+#### Annotation process
+
+Amazon Turk Workers were provided with human written summaries of the stories (To make the annotation tractable and to lead annotators towards asking non-localized questions). Stories were matched with plot summaries from Wikipedia using titles and verified the matching with help from human annotators. The annotators were asked to determine if both the story and the summary refer to a movie or a book (as some books are made into movies), or if they are the same part in a series produced in the same year. Annotators on Amazon Mechanical Turk were instructed to write 10 question–answer pairs each based solely on a given summary. Annotators were instructed to imagine that they are writing questions to test students who have read the full stories but not the summaries. We required questions that are specific enough, given the length and complexity of the narratives, and to provide adiverse set of questions about characters, events, why this happened, and so on. Annotators were encouraged to use their own words and we prevented them from copying. We asked for answers that are grammatical, complete sentences, and explicitly allowed short answers (one word, or a few-word phrase, or ashort sentence) as we think that answering with a full sentence is frequently perceived as artificial when asking about factual information. Annotators were asked to avoid extra, unnecessary information in the question or the answer, and to avoid yes/no questions or questions about the author or the actors.
+
+#### Who are the annotators?
+
+Amazon Mechanical Turk workers.
+
+### Personal and Sensitive Information
+
+None
+
+## 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
+
+[More Information Needed]
+
+### Licensing Information
+
+The dataset is released under a [Apache-2.0 License](https://github.com/deepmind/narrativeqa/blob/master/LICENSE).
+
+### Citation Information
+
+```
+@article{narrativeqa,
+author = {Tom\'a\v s Ko\v cisk\'y and Jonathan Schwarz and Phil Blunsom and
+          Chris Dyer and Karl Moritz Hermann and G\'abor Melis and
+          Edward Grefenstette},
+title = {The {NarrativeQA} Reading Comprehension Challenge},
+journal = {Transactions of the Association for Computational Linguistics},
+url = {https://TBD},
+volume = {TBD},
+year = {2018},
+pages = {TBD},
+}
+```
+
+### Contributions
+
+Thanks to [@rsanjaykamath](https://github.com/rsanjaykamath) for adding this dataset.

dataset_infos.json

@@ -0,0 +1 @@
+{"default": {"description": "The Narrative QA Manual dataset is a reading comprehension dataset, in which the reader must answer questions about stories by reading entire books or movie scripts. The QA tasks are designed so that successfully answering their questions requires understanding the underlying narrative rather than relying on shallow pattern matching or salience.\\\nTHIS DATASET REQUIRES A MANUALLY DOWNLOADED FILE! Because of a script in the original repository which downloads the stories from original URLs everytime, The links are sometimes broken or invalid.  Therefore, you need to manually download the stories for this dataset using the script provided by the authors (https://github.com/deepmind/narrativeqa/blob/master/download_stories.sh). Running the shell script creates a folder named \"tmp\" in the root directory and downloads the stories there. This folder containing the storiescan be used to load the dataset via `datasets.load_dataset(\"narrativeqa_manual\", data_dir=\"<path/to/folder>\")`.                ", "citation": "@article{kovcisky2018narrativeqa,\n  title={The narrativeqa reading comprehension challenge},\n  author={Ko{\u000b{c}}isk{'y}, Tom{'a}{\u000b{s}} and Schwarz, Jonathan and Blunsom, Phil and Dyer, Chris and Hermann, Karl Moritz and Melis, G{'a}bor and Grefenstette, Edward},\n  journal={Transactions of the Association for Computational Linguistics},\n  volume={6},\n  pages={317--328},\n  year={2018},\n  publisher={MIT Press}\n}\n", "homepage": "https://deepmind.com/research/publications/narrativeqa-reading-comprehension-challenge", "license": "https://github.com/deepmind/narrativeqa/blob/master/LICENSE", "features": {"document": {"id": {"dtype": "string", "id": null, "_type": "Value"}, "kind": {"dtype": "string", "id": null, "_type": "Value"}, "url": {"dtype": "string", "id": null, "_type": "Value"}, "file_size": {"dtype": "int32", "id": null, "_type": "Value"}, "word_count": {"dtype": "int32", "id": null, "_type": "Value"}, "start": {"dtype": "string", "id": null, "_type": "Value"}, "end": {"dtype": "string", "id": null, "_type": "Value"}, "summary": {"text": {"dtype": "string", "id": null, "_type": "Value"}, "tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "url": {"dtype": "string", "id": null, "_type": "Value"}, "title": {"dtype": "string", "id": null, "_type": "Value"}}, "text": {"dtype": "string", "id": null, "_type": "Value"}}, "question": {"text": {"dtype": "string", "id": null, "_type": "Value"}, "tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}}, "answers": [{"text": {"dtype": "string", "id": null, "_type": "Value"}, "tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}}]}, "post_processed": null, "supervised_keys": null, "builder_name": "narrativeqa_manual", "config_name": "default", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 9115940054, "num_examples": 32747, "dataset_name": "narrativeqa_manual"}, "test": {"name": "test", "num_bytes": 2911702563, "num_examples": 10557, "dataset_name": "narrativeqa_manual"}, "validation": {"name": "validation", "num_bytes": 968994186, "num_examples": 3461, "dataset_name": "narrativeqa_manual"}}, "download_checksums": {"https://raw.githubusercontent.com/deepmind/narrativeqa/master/documents.csv": {"num_bytes": 341683, "checksum": "6dffa4cc0b5c9963fe3a097c87f04aa7767da36627500cc7a0d69e2405e1144a"}, "https://raw.githubusercontent.com/deepmind/narrativeqa/master/third_party/wikipedia/summaries.csv": {"num_bytes": 10821085, "checksum": "87d12b849219015c4fe717e95c707671d802c181145e8ba2acc11dff23ea7c75"}, "https://raw.githubusercontent.com/deepmind/narrativeqa/master/qaps.csv": {"num_bytes": 11475505, "checksum": "990b02af0b5280de210f0e6b80f43b3fab80dc6de630c4d5059a1b7131c26e38"}}, "download_size": 22638273, "post_processing_size": null, "dataset_size": 12996636803, "size_in_bytes": 13019275076}}

dummy/1.0.0/dummy_data.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:23516fde7bc6e3cdba094b1e0d339d1836818f8adec6335a27c8e0ee4f498167
+size 4698

narrativeqa_manual.py

@@ -0,0 +1,220 @@
+# 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.
+"""NarrativeQA Reading Comprehension Challenge"""
+
+from __future__ import absolute_import, division, print_function
+
+import csv
+import os
+from os import listdir
+from os.path import isfile, join
+
+import datasets
+
+
+_CITATION = """\
+@article{kovcisky2018narrativeqa,
+  title={The narrativeqa reading comprehension challenge},
+  author={Ko{\v{c}}isk{\'y}, Tom{\'a}{\v{s}} and Schwarz, Jonathan and Blunsom, Phil and Dyer, Chris and Hermann, Karl Moritz and Melis, G{\'a}bor and Grefenstette, Edward},
+  journal={Transactions of the Association for Computational Linguistics},
+  volume={6},
+  pages={317--328},
+  year={2018},
+  publisher={MIT Press}
+}
+"""
+
+
+_DESCRIPTION = """\
+The Narrative QA Manual dataset is a reading comprehension \
+dataset, in which the reader must answer questions about stories \
+by reading entire books or movie scripts. \
+The QA tasks are designed so that successfully answering their questions \
+requires understanding the underlying narrative rather than \
+relying on shallow pattern matching or salience.\\
+THIS DATASET REQUIRES A MANUALLY DOWNLOADED FILE! \
+Because of a script in the original repository which downloads the stories from original URLs everytime, \
+The links are sometimes broken or invalid.  \
+Therefore, you need to manually download the stories for this dataset using the script provided by the authors \
+(https://github.com/deepmind/narrativeqa/blob/master/download_stories.sh). Running the shell script creates a folder named "tmp" \
+in the root directory and downloads the stories there. This folder containing the stories\
+can be used to load the dataset via `datasets.load_dataset("narrativeqa_manual", data_dir="<path/to/folder>")`.                """
+
+
+_HOMEPAGE = "https://deepmind.com/research/publications/narrativeqa-reading-comprehension-challenge"
+_LICENSE = "https://github.com/deepmind/narrativeqa/blob/master/LICENSE"
+
+
+# The HuggingFace dataset library don't host the datasets but only point to the original files
+# This can be an arbitrary nested dict/list of URLs (see below in `_split_generators` method)
+_URL = "https://github.com/deepmind/narrativeqa"
+_URLS = {
+    "documents": "https://raw.githubusercontent.com/deepmind/narrativeqa/master/documents.csv",
+    "summaries": "https://raw.githubusercontent.com/deepmind/narrativeqa/master/third_party/wikipedia/summaries.csv",
+    "qaps": "https://raw.githubusercontent.com/deepmind/narrativeqa/master/qaps.csv",
+}
+
+
+class NarrativeqaManual(datasets.GeneratorBasedBuilder):
+    """The NarrativeQA Manual dataset"""
+
+    VERSION = datasets.Version("1.0.0")
+
+    @property
+    def manual_download_instructions(self):
+        return """ You need to manually download the stories for this dataset using the script provided by the authors \
+                (https://github.com/deepmind/narrativeqa/blob/master/download_stories.sh). Running the shell script creates a folder named "tmp"\
+                in the root directory and downloads the stories there. This folder containing the stories\
+                can be used to load the dataset via `datasets.load_dataset("narrativeqa_manual", data_dir="<path/to/folder>")."""
+
+    def _info(self):
+
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "document": {
+                        "id": datasets.Value("string"),
+                        "kind": datasets.Value("string"),
+                        "url": datasets.Value("string"),
+                        "file_size": datasets.Value("int32"),
+                        "word_count": datasets.Value("int32"),
+                        "start": datasets.Value("string"),
+                        "end": datasets.Value("string"),
+                        "summary": {
+                            "text": datasets.Value("string"),
+                            "tokens": datasets.features.Sequence(datasets.Value("string")),
+                            "url": datasets.Value("string"),
+                            "title": datasets.Value("string"),
+                        },
+                        "text": datasets.Value("string"),
+                    },
+                    "question": {
+                        "text": datasets.Value("string"),
+                        "tokens": datasets.features.Sequence(datasets.Value("string")),
+                    },
+                    "answers": [
+                        {
+                            "text": datasets.Value("string"),
+                            "tokens": datasets.features.Sequence(datasets.Value("string")),
+                        }
+                    ],
+                }
+            ),
+            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)
+        manual_dir = os.path.abspath(os.path.expanduser(dl_manager.manual_dir))
+
+        if not os.path.exists(manual_dir):
+            raise FileNotFoundError(
+                "{} does not exist. Make sure you insert a manual dir via `datasets.load_dataset('narrativeqa_manual', data_dir=...)` that includes the stories downloaded from the original repository. Manual download instructions: {}".format(
+                    manual_dir, self.manual_download_instructions
+                )
+            )
+
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={
+                    "data_dir": data_dir,
+                    "manual_dir": manual_dir,
+                    "split": "train",
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                gen_kwargs={
+                    "data_dir": data_dir,
+                    "manual_dir": manual_dir,
+                    "split": "test",
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                gen_kwargs={
+                    "data_dir": data_dir,
+                    "manual_dir": manual_dir,
+                    "split": "valid",
+                },
+            ),
+        ]
+
+    def _generate_examples(self, data_dir, manual_dir, split):
+        """ Yields examples. """
+
+        documents = {}
+        with open(data_dir["documents"], encoding="utf-8") as f:
+            reader = csv.DictReader(f)
+            for row in reader:
+                if row["set"] != split:
+                    continue
+                documents[row["document_id"]] = row
+
+        summaries = {}
+        with open(data_dir["summaries"], encoding="utf-8") as f:
+            reader = csv.DictReader(f)
+            for row in reader:
+                if row["set"] != split:
+                    continue
+                summaries[row["document_id"]] = row
+
+        onlyfiles = [f for f in listdir(manual_dir) if isfile(join(manual_dir, f))]
+        story_texts = {}
+        for i in onlyfiles:
+            if "content" in i:
+                with open(os.path.join(manual_dir, i), "r", encoding="utf-8", errors="ignore") as f:
+                    text = f.read()
+                    story_texts[i.split(".")[0]] = text
+
+        with open(data_dir["qaps"], encoding="utf-8") as f:
+            reader = csv.DictReader(f)
+            for id_, row in enumerate(reader):
+                if row["set"] != split:
+                    continue
+                document_id = row["document_id"]
+                document = documents[document_id]
+                summary = summaries[document_id]
+                full_text = story_texts[document_id]
+                res = {
+                    "document": {
+                        "id": document["document_id"],
+                        "kind": document["kind"],
+                        "url": document["story_url"],
+                        "file_size": document["story_file_size"],
+                        "word_count": document["story_word_count"],
+                        "start": document["story_start"],
+                        "end": document["story_end"],
+                        "summary": {
+                            "text": summary["summary"],
+                            "tokens": summary["summary_tokenized"].split(),
+                            "url": document["wiki_url"],
+                            "title": document["wiki_title"],
+                        },
+                        "text": full_text,
+                    },
+                    "question": {"text": row["question"], "tokens": row["question_tokenized"].split()},
+                    "answers": [
+                        {"text": row["answer1"], "tokens": row["answer1_tokenized"].split()},
+                        {"text": row["answer2"], "tokens": row["answer2_tokenized"].split()},
+                    ],
+                }
+                yield id_, res