V0.1

README.md

@@ -0,0 +1,93 @@
+---
+annotations_creators:
+- found
+language_creators:
+- found
+language:
+- en
+license:
+- unknown
+multilinguality:
+- monolingual
+size_categories:
+- 1K<n<10K
+source_datasets:
+- original
+task_categories:
+- other
+task_ids:
+- other-other-story-completion
+paperswithcode_id: null
+pretty_name: Story Cloze Test
+---
+# Dataset Card for "story_cloze"
+## 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:** [https://cs.rochester.edu/nlp/rocstories/](https://cs.rochester.edu/nlp/rocstories/)
+- **Repository:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+- **Paper:** [Lsdsem 2017 shared task: The story cloze test](https://aclanthology.org/W17-0906.pdf)
+- **Point of Contact:** [Nasrin Mostafazadeh](nasrinm@cs.rochester.edu)
+- **Size of downloaded dataset files:** 2.03 MB
+- **Size of the generated dataset:** 2.03 MB
+- **Total amount of disk used:** 2.05 MB
+### Dataset Summary
+Story Cloze Test' is a new commonsense reasoning framework for evaluating story understanding, 
+story generation, and script learning.This test requires a system to choose the correct ending 
+to a four-sentence story.
+### Supported Tasks and Leaderboards
+commonsense reasoning
+### Languages
+English
+## Dataset Structure
+### Data Instances
+- **Size of downloaded dataset files:** 2.03 MB
+- **Size of the generated dataset:** 2.03 MB
+- **Total amount of disk used:** 2.05 MB
+An example of 'train' looks as follows.
+```
+{'answer_right_ending': 1,
+ 'input_sentence_1': 'Rick grew up in a troubled household.',
+ 'input_sentence_2': 'He never found good support in family, and turned to gangs.',
+ 'input_sentence_3': "It wasn't long before Rick got shot in a robbery.",
+ 'input_sentence_4': 'The incident caused him to turn a new leaf.',
+ 'sentence_quiz1': 'He is happy now.',
+ 'sentence_quiz2': 'He joined a gang.',
+ 'story_id': '138d5bfb-05cc-41e3-bf2c-fa85ebad14e2'}
+```
+### Data Fields
+The data fields are the same among all splits.
+- `input_sentence_1`: The first statement in the story.
+- `input_sentence_2`: The second statement in the story.
+- `input_sentence_3`: The third statement in the story.
+- `input_sentence_4`: The forth statement in the story.
+- `sentence_quiz1`: first possible continuation of the story. 
+- `sentence_quiz2`: second possible continuation of the story. 
+- `answer_right_ending`: correct possible ending; either 1 or 2. 
+- `story_id`: story id. 
+### Data Splits
+| name  |validation |test|
+|-------|-----:|---:|
+|2016|1871|1871|
+|2018|1571|-|

xstory_cloze.py

@@ -0,0 +1,151 @@
+# 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.
+"""Story Cloze datasets."""
+
+
+import csv
+import os
+
+import datasets
+
+
+_DESCRIPTION = """
+Story Cloze Test' is a commonsense reasoning framework for evaluating story understanding,
+story generation, and script learning.This test requires a system to choose the correct ending
+to a four-sentence story.
+"""
+
+_CITATION = """\
+@article{DBLP:journals/corr/abs-2112-10668,
+  author    = {Xi Victoria Lin and
+               Todor Mihaylov and
+               Mikel Artetxe and
+               Tianlu Wang and
+               Shuohui Chen and
+               Daniel Simig and
+               Myle Ott and
+               Naman Goyal and
+               Shruti Bhosale and
+               Jingfei Du and
+               Ramakanth Pasunuru and
+               Sam Shleifer and
+               Punit Singh Koura and
+               Vishrav Chaudhary and
+               Brian O'Horo and
+               Jeff Wang and
+               Luke Zettlemoyer and
+               Zornitsa Kozareva and
+               Mona T. Diab and
+               Veselin Stoyanov and
+               Xian Li},
+  title     = {Few-shot Learning with Multilingual Language Models},
+  journal   = {CoRR},
+  volume    = {abs/2112.10668},
+  year      = {2021},
+  url       = {https://arxiv.org/abs/2112.10668},
+  eprinttype = {arXiv},
+  eprint    = {2112.10668},
+  timestamp = {Tue, 04 Jan 2022 15:59:27 +0100},
+  biburl    = {https://dblp.org/rec/journals/corr/abs-2112-10668.bib},
+  bibsource = {dblp computer science bibliography, https://dblp.org}
+}
+"""
+
+
+_LANG = ["ru", "zh", "es", "ar", "hi", "id", "te", "sw", "eu", "my"]
+_VERSION = "1.0.0"
+
+
+class XStoryCloze(datasets.GeneratorBasedBuilder):
+    """Story Cloze."""
+
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(
+            name=lang,
+            description=f"XStory Cloze {lang}",
+            version=_VERSION,
+        )
+        for lang in _LANG
+    ]
+
+    @property
+    def manual_download_instructions(self):
+        return (
+            "To use Story Cloze you have to download it manually. Please fill this "
+            "google form (http://goo.gl/forms/aQz39sdDrO). Complete the form. "
+            "Then you will receive a download link for the dataset. Load it using: "
+            "`datasets.load_dataset('story_cloze', data_dir='path/to/folder/folder_name')`"
+        )
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "story_id": datasets.Value("string"),
+                    "input_sentence_1": datasets.Value("string"),
+                    "input_sentence_2": datasets.Value("string"),
+                    "input_sentence_3": datasets.Value("string"),
+                    "input_sentence_4": datasets.Value("string"),
+                    "sentence_quiz1": datasets.Value("string"),
+                    "sentence_quiz2": datasets.Value("string"),
+                    "answer_right_ending": datasets.Value("int32"),
+                }
+            ),
+            homepage="https://cs.rochester.edu/nlp/rocstories/",
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        path_to_manual_folder = os.path.abspath(os.path.expanduser(dl_manager.manual_dir))
+
+        train_file = os.path.join(path_to_manual_folder, f"spring2016.val.{self.config.name}.tsv.split_20_80_train.tsv")
+        val_file = os.path.join(path_to_manual_folder, f"spring2016.val.{self.config.name}.tsv.split_20_80_eval.tsv")
+
+        return [
+                datasets.SplitGenerator(
+                    name=datasets.Split.TRAIN,
+                    gen_kwargs={
+                        "filepath": train_file,
+                    },
+                ),
+                datasets.SplitGenerator(
+                    name=datasets.Split.VALIDATION,
+                    gen_kwargs={
+                        "filepath": val_file,
+                    },
+                ),
+            ]
+
+    def _generate_examples(self, filepath):
+        """Generate Story Cloze examples."""
+        with open(filepath, encoding="utf-8") as tsv_file:
+            csv_reader = csv.reader(
+                tsv_file, quotechar='"', delimiter="\t", quoting=csv.QUOTE_ALL, skipinitialspace=True
+            )
+            _ = next(csv_reader)
+            for id_, row in enumerate(csv_reader):
+                if row and len(row) == 8:
+                    yield id_, {
+                        "story_id": row[0],
+                        "input_sentence_1": row[1],
+                        "input_sentence_2": row[2],
+                        "input_sentence_3": row[3],
+                        "input_sentence_4": row[4],
+                        "sentence_quiz1": row[5],
+                        "sentence_quiz2": row[6],
+                        "answer_right_ending": int(row[7]),
+                    }
+