Add scripts and dataset card

RotoWire_English-German.py

@@ -0,0 +1,207 @@
+# 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.
+"""Dataloader for RotoWire English-German dataset."""
+
+import json
+import os
+
+import datasets
+
+
+# Find for instance the citation on arxiv or on the dataset repo/website
+_CITATION = """\
+@article{hayashi2019findings,
+  title={Findings of the Third Workshop on Neural Generation and Translation},
+  author={Hayashi, Hiroaki and Oda, Yusuke and Birch, Alexandra and Konstas, Ioannis and Finch, Andrew and Luong, Minh-Thang and Neubig, Graham and Sudoh, Katsuhito},
+  journal={EMNLP-IJCNLP 2019},
+  pages={1},
+  year={2019}
+}
+"""
+
+# You can copy an official description
+_DESCRIPTION = """\
+Dataset for the WNGT 2019 DGT shared task on "Document-Level Generation and Translation”.
+"""
+
+_HOMEPAGE = "https://sites.google.com/view/wngt19/dgt-task"
+
+_LICENSE = "CC-BY 4.0"
+
+# 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)
+_URLs = {
+    "train": "train.json",
+    "validation": "validation.json",
+    "test": "test.json"
+}
+
+
+class RotowireEnglishGerman(datasets.GeneratorBasedBuilder):
+    """Dataset for WNGT2019 shared task on Document-level Generation and Translation."""
+
+    VERSION = datasets.Version("1.1.0")
+
+    # This is an example of a dataset with multiple configurations.
+    # If you don't want/need to define several sub-sets in your dataset,
+    # just remove the BUILDER_CONFIG_CLASS and the BUILDER_CONFIGS attributes.
+
+    # If you need to make complex sub-parts in the datasets with configurable options
+    # You can create your own builder configuration class to store attribute, inheriting from datasets.BuilderConfig
+    # BUILDER_CONFIG_CLASS = MyBuilderConfig
+
+    # You will be able to load one or the other configurations in the following list with
+    # data = datasets.load_dataset('my_dataset', 'first_domain')
+    # data = datasets.load_dataset('my_dataset', 'second_domain')
+    # BUILDER_CONFIGS = [
+    #     datasets.BuilderConfig(name="nlg_en", version=VERSION, description="NLG: Data-to-English text."),
+    #     datasets.BuilderConfig(name="nlg_de", version=VERSION, description="NLG: Data-to-German text."),
+    #     datasets.BuilderConfig(name="mt_en-de", version=VERSION, description="MT: English-to-German text."),
+    #     datasets.BuilderConfig(name="mt_de-en", version=VERSION, description="MT: German-to-English text."),
+    #     datasets.BuilderConfig(name="nlg+mt_en-de", version=VERSION, description="NLG+MT: Data+English-to-German text."),
+    #     datasets.BuilderConfig(name="nlg+mt_de-en", version=VERSION, description="NLG+MT: Data+German-to-English text."),
+    # ]
+
+    def _info(self):
+        # max 26 entries in each box_score field.
+        box_score_entry = {str(i): datasets.Value("string") for i in range(26)}
+        box_score_features = {
+            "FIRST_NAME": box_score_entry,
+            "MIN": box_score_entry,
+            "FGM": box_score_entry,
+            "REB": box_score_entry,
+            "FG3A": box_score_entry,
+            "PLAYER_NAME": box_score_entry,
+            "AST": box_score_entry,
+            "FG3M": box_score_entry,
+            "OREB": box_score_entry,
+            "TO": box_score_entry,
+            "START_POSITION": box_score_entry,
+            "PF": box_score_entry,
+            "PTS": box_score_entry,
+            "FGA": box_score_entry,
+            "STL": box_score_entry,
+            "FTA": box_score_entry,
+            "BLK": box_score_entry,
+            "DREB": box_score_entry,
+            "FTM": box_score_entry,
+            "FT_PCT": box_score_entry,
+            "FG_PCT": box_score_entry,
+            "FG3_PCT": box_score_entry,
+            "SECOND_NAME": box_score_entry,
+            "TEAM_CITY": box_score_entry,
+        }
+        line_features = {
+            "TEAM-PTS_QTR2": datasets.Value("string"),
+            "TEAM-FT_PCT": datasets.Value("string"),
+            "TEAM-PTS_QTR1": datasets.Value("string"),
+            "TEAM-PTS_QTR4": datasets.Value("string"),
+            "TEAM-PTS_QTR3": datasets.Value("string"),
+            "TEAM-CITY": datasets.Value("string"),
+            "TEAM-PTS": datasets.Value("string"),
+            "TEAM-AST": datasets.Value("string"),
+            "TEAM-LOSSES": datasets.Value("string"),
+            "TEAM-NAME": datasets.Value("string"),
+            "TEAM-WINS": datasets.Value("string"),
+            "TEAM-REB": datasets.Value("string"),
+            "TEAM-TOV": datasets.Value("string"),
+            "TEAM-FG3_PCT": datasets.Value("string"),
+            "TEAM-FG_PCT": datasets.Value("string")
+        }
+        features = datasets.Features(
+            {
+                "id":datasets.Value("string"),
+                "gem_id":datasets.Value("string"),
+                "home_name": datasets.Value("string"),
+                "box_score": box_score_features,
+                "vis_name": datasets.Value("string"),
+                "summary": datasets.Sequence(datasets.Value("string")),
+                "home_line": line_features,
+                "home_city": datasets.Value("string"),
+                "vis_line": line_features,
+                "vis_city": datasets.Value("string"),
+                "day": datasets.Value("string"),
+                "detok_summary_org": datasets.Value("string"),
+                "detok_summary":  datasets.Value("string"),
+                "summary_en": datasets.Sequence(datasets.Value("string")),
+                "sentence_end_index_en": datasets.Sequence(datasets.Value("int32")),
+                "summary_de": datasets.Sequence(datasets.Value("string")),
+                "sentence_end_index_de": datasets.Sequence(datasets.Value("int32"))
+            }
+        )
+        return datasets.DatasetInfo(
+            # This is the description that will appear on the datasets page.
+            description=_DESCRIPTION,
+            # This defines the different columns of the dataset and their types
+            features=features,  # Here we define them above because they are different between the two configurations
+            # If there's a common (input, target) tuple from the features,
+            # specify them here. They'll be used if as_supervised=True in
+            # builder.as_dataset.
+            supervised_keys=None,
+            # Homepage of the dataset for documentation
+            homepage=_HOMEPAGE,
+            # License for the dataset if available
+            license=_LICENSE,
+            # Citation for the dataset
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        # TODO: This method is tasked with downloading/extracting the data and defining the splits depending on the configuration
+        # If several configurations are possible (listed in BUILDER_CONFIGS), the configuration selected by the user is in self.config.name
+
+        # dl_manager is a datasets.download.DownloadManager that can be used to download and extract URLs
+        # It can accept any type or nested list/dict and will give back the same structure with the url replaced with path to local files.
+        # By default the archives will be extracted and a path to a cached folder where they are extracted is returned instead of the archive
+        data_dir = dl_manager.download_and_extract(_URLs)
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "filepath": data_dir["train"],
+                    "split": "train",
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "filepath": data_dir["test"],
+                    "split": "test"
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "filepath": data_dir["validation"],
+                    "split": "validation",
+                },
+            ),
+        ]
+
+    def _generate_examples(
+        self, filepath, split  # method parameters are unpacked from `gen_kwargs` as given in `_split_generators`
+    ):
+        """ Yields examples as (key, example) tuples. """
+        # This method handles input defined in _split_generators to yield (key, example) tuples from the dataset.
+        # The `key` is here for legacy reason (tfds) and is not important in itself.
+
+        with open(filepath, encoding="utf-8") as f:
+            all_data = json.load(f)
+            for id_, data in enumerate(all_data):
+                yield id_, data

rotowire_english_german-11_22_2021_19_36_35.json

@@ -0,0 +1,180 @@
+{
+  "overview": {
+    "where": {
+      "has-leaderboard": "no",
+      "leaderboard-url": "N/A",
+      "leaderboard-description": "N/A",
+      "website": "https://sites.google.com/view/wngt19/dgt-task",
+      "data-url": "https://github.com/neulab/dgt",
+      "paper-url": "https://www.aclweb.org/anthology/D19-5601/",
+      "paper-bibtext": "@inproceedings{hayashi-etal-2019-findings,\n    title = \"Findings of the Third Workshop on Neural Generation and Translation\",\n    author = \"Hayashi, Hiroaki  and\n      Oda, Yusuke  and\n      Birch, Alexandra  and\n      Konstas, Ioannis  and\n      Finch, Andrew  and\n      Luong, Minh-Thang  and\n      Neubig, Graham  and\n      Sudoh, Katsuhito\",\n    booktitle = \"Proceedings of the 3rd Workshop on Neural Generation and Translation\",\n    month = nov,\n    year = \"2019\",\n    address = \"Hong Kong\",\n    publisher = \"Association for Computational Linguistics\",\n    url = \"https://aclanthology.org/D19-5601\",\n    doi = \"10.18653/v1/D19-5601\",\n    pages = \"1--14\",\n    abstract = \"This document describes the findings of the Third Workshop on Neural Generation and Translation, held in concert with the annual conference of the Empirical Methods in Natural Language Processing (EMNLP 2019). First, we summarize the research trends of papers presented in the proceedings. Second, we describe the results of the two shared tasks 1) efficient neural machine translation (NMT) where participants were tasked with creating NMT systems that are both accurate and efficient, and 2) document generation and translation (DGT) where participants were tasked with developing systems that generate summaries from structured data, potentially with assistance from text in another language.\",\n}",
+      "contact-name": "Hiroaki Hayashi",
+      "contact-email": "[email protected]"
+    },
+    "languages": {
+      "is-multilingual": "yes",
+      "license": "cc-by-4.0: Creative Commons Attribution 4.0 International",
+      "task-other": "N/A",
+      "language-names": [
+        "English",
+        "German"
+      ],
+      "intended-use": "Foster the research on document-level generation technology and contrast the methods for different types of inputs.",
+      "license-other": "N/A",
+      "task": "Data-to-Text",
+      "communicative": "Describe a basketball game given its box score table (and possibly a summary in a foreign language)."
+    },
+    "credit": {
+      "organization-type": [
+        "academic"
+      ],
+      "organization-names": "Carnegie Mellon University",
+      "creators": "Graham Neubig (Carnegie Mellon University), Hiroaki Hayashi (Carnegie Mellon University)",
+      "funding": "Graham Neubig",
+      "gem-added-by": "Hiroaki Hayashi (Carnegie Mellon University)"
+    },
+    "structure": {
+      "data-fields": "- `id` (`string`): The identifier from the original dataset.\n- `gem_id` (`string`): The identifier from GEMv2.\n- `day` (`string`): Date of the game (Format: `MM_DD_YY`)\n- `home_name` (`string`): Home team name.\n- `home_city` (`string`): Home team city name.\n- `vis_name` (`string`): Visiting (Away) team name.\n- `vis_city` (`string`): Visiting team (Away) city name.\n- `home_line` (`Dict[str, str]`): Home team statistics (e.g., team free throw percentage).\n- `vis_line` (`Dict[str, str]`): Visiting team statistics (e.g., team free throw percentage).\n- `box_score` (`Dict[str, Dict[str, str]]`): Box score table. (Stat_name to [player ID to stat_value].)\n- `summary_en` (`List[string]`): Tokenized target summary in English.\n- `sentence_end_index_en` (`List[int]`): Sentence end indices for `summary_en`.\n- `summary_de` (`List[string]`): Tokenized target summary in German.\n- `sentence_end_index_de` (`List[int]`): ): Sentence end indices for `summary_de`.\n- (Unused) `detok_summary_org` (`string`): Original summary provided by RotoWire dataset.\n- (Unused) `summary` (`List[string]`): Tokenized summary of `detok_summary_org`.\n- (Unused) `detok_summary` (`string`): Detokenized (with organizer's detokenizer) summary of `summary`.\n",
+      "structure-description": "- Structured data are directly imported from the original RotoWire dataset.\n- Textual data (English, German) are associated to each sample.",
+      "structure-labels": "N/A",
+      "structure-splits": "- Train\n- Validation\n- Test",
+      "structure-example": "{\n  'id': '11_02_16-Jazz-Mavericks-TheUtahJazzdefeatedthe',\n  'gem_id': 'GEM-RotoWire_English-German-train-0'\n  'day': '11_02_16',\n  'home_city': 'Utah',\n  'home_name': 'Jazz',\n  'vis_city': 'Dallas',\n  'vis_name': 'Mavericks',\n  'home_line': {\n    'TEAM-FT_PCT': '58', ...\n  },\n  'vis_line': {\n    'TEAM-FT_PCT': '80', ...\n  },\n  'box_score': {\n    'PLAYER_NAME': {\n      '0': 'Harrison Barnes', ...\n  }, ...\n  'summary_en': ['The', 'Utah', 'Jazz', 'defeated', 'the', 'Dallas', 'Mavericks', ...],\n  'sentence_end_index_en': [16, 52, 100, 137, 177, 215, 241, 256, 288],\n  'summary_de': ['Die', 'Utah', 'Jazz', 'besiegten', 'am', 'Mittwoch', 'in', 'der', ...],\n  'sentence_end_index_de': [19, 57, 107, 134, 170, 203, 229, 239, 266],\n  'detok_summary_org': \"The Utah Jazz defeated the Dallas Mavericks 97 - 81 ...\",\n  'detok_summary': \"The Utah Jazz defeated the Dallas Mavericks 97-81 ...\",\n  'summary': ['The', 'Utah', 'Jazz', 'defeated', 'the', 'Dallas', 'Mavericks', ...],\n}",
+      "structure-splits-criteria": "- English summaries are provided sentence-by-sentence to professional German translators with basketball knowledge to obtain sentence-level German translations.\n- Split criteria follows the original RotoWire dataset.",
+      "structure-outlier": "- The (English) summary length in the training set varies from 145 to 650 words, with an average of 323 words."
+    }
+  },
+  "curation": {
+    "original": {
+      "is-aggregated": "yes",
+      "aggregated-sources": "RotoWire",
+      "rationale": "A random subset of RotoWire dataset was chosen for German translation annotation.",
+      "communicative": "Foster the research on document-level generation technology and contrast the methods for different types of inputs."
+    },
+    "language": {
+      "found": [],
+      "crowdsourced": [],
+      "created": "Professional German language translators were hired to translate basketball summaries from a subset of RotoWire dataset.",
+      "machine-generated": "N/A",
+      "validated": "validated by data curator",
+      "is-filtered": "not filtered",
+      "filtered-criteria": "N/A",
+      "obtained": [
+        "Created for the dataset"
+      ],
+      "producers-description": "Translators are familiar with basketball terminology.",
+      "topics": "Basketball (NBA) game summaries.",
+      "pre-processed": "Sentence-level translations were aligned back to the original English summary sentences."
+    },
+    "annotations": {
+      "origin": "automatically created",
+      "rater-number": "N/A",
+      "rater-qualifications": "N/A",
+      "rater-training-num": "N/A",
+      "rater-test-num": "N/A",
+      "rater-annotation-service-bool": "no",
+      "rater-annotation-service": [],
+      "values": "Sentence-end indices for the tokenized summaries. Sentence boundaries can help users accurately identify aligned sentences in both languages, as well as allowing an accurate evaluation that involves sentence boundaries (ROUGE-L).",
+      "quality-control": "validated through automated script",
+      "quality-control-details": "Token and number overlaps between pairs of aligned sentences are measured."
+    },
+    "consent": {
+      "has-consent": "no",
+      "consent-policy": "N/A",
+      "consent-other": "N/A",
+      "no-consent-justification": "Reusing by citing the original papers:\n- Sam Wiseman, Stuart M. Shieber, Alexander M. Rush:\nChallenges in Data-to-Document Generation. EMNLP 2017.\n- Hiroaki Hayashi, Yusuke Oda, Alexandra Birch, Ioannis Konstas, Andrew Finch, Minh-Thang Luong, Graham Neubig, Katsuhito Sudoh. Findings of the Third Workshop on Neural Generation and Translation. WNGT 2019."
+    },
+    "pii": {
+      "has-pii": "unlikely",
+      "no-pii-justification": "N/A",
+      "is-pii-identified": "no identification",
+      "pii-identified-method": "N/A",
+      "is-pii-replaced": "N/A",
+      "pii-replaced-method": "N/A",
+      "pii-categories": [
+        "generic PII"
+      ]
+    },
+    "maintenance": {
+      "has-maintenance": "no",
+      "description": "N/A",
+      "contact": "N/A",
+      "contestation-mechanism": "N/A",
+      "contestation-link": "N/A",
+      "contestation-description": "N/A"
+    }
+  },
+  "gem": {
+    "rationale": {
+      "sole-task-dataset": "yes",
+      "distinction-description": "The potential use of two modalities (data, foreign text) as input.",
+      "sole-language-task-dataset": "yes",
+      "contribution": "The use of two modalities (data, foreign text) to generate a document-level text summary.",
+      "model-ability": "- Translation\n- Data-to-text verbalization\n- Aggregation of the two above."
+    },
+    "curation": {
+      "has-additional-curation": "yes",
+      "modification-types": [
+        "other"
+      ],
+      "modification-description": "- Added GEM ID in each sample.\n- Normalize the number of players in each sample with \"N/A\" for consistent data loading.",
+      "has-additional-splits": "no",
+      "additional-splits-description": "N/A",
+      "additional-splits-capacicites": "N/A"
+    },
+    "starting": {
+      "technical-terms": "- Data-to-text\n- Neural machine translation (NMT)\n- Document-level generation and translation (DGT) ",
+      "research-pointers": "- https://aclanthology.org/D17-1239\n- https://ojs.aaai.org//index.php/AAAI/article/view/4668\n- https://aclanthology.org/D19-5601"
+    }
+  },
+  "results": {
+    "results": {
+      "other-metrics-definitions": "Model-based measures proposed by (Wiseman et al., 2017):\n- Relation Generation\n- Content Selection\n- Content Ordering",
+      "has-previous-results": "yes",
+      "current-evaluation": "N/A.",
+      "previous-results": "See Table 2 to 7 of (https://aclanthology.org/D19-5601) for previous results for this dataset.",
+      "metrics": [
+        "BLEU",
+        "ROUGE",
+        "Other: Other Metrics"
+      ],
+      "original-evaluation": "To evaluate the fidelity of the generated content to the input data.",
+      "model-abilities": "- Textual accuracy towards the gold-standard summary.\n- Content faithfulness to the input structured data."
+    }
+  },
+  "considerations": {
+    "pii": {
+      "risks-description": "- Structured data contain real National Basketball Association player and organization names."
+    },
+    "licenses": {
+      "dataset-restrictions-other": "N/A",
+      "data-copyright-other": "N/A",
+      "dataset-restrictions": [
+        "open license - commercial use allowed"
+      ],
+      "data-copyright": [
+        "open license - commercial use allowed"
+      ]
+    },
+    "limitations": {
+      "data-technical-limitations": "Potential overlap of box score tables between splits. This was extensively studied and pointed out by [1].\n\n[1]: Thomson, Craig, Ehud Reiter, and Somayajulu Sripada. \"SportSett: Basketball-A robust and maintainable data-set for Natural Language Generation.\" Proceedings of the Workshop on Intelligent Information Processing and Natural Language Generation. 2020.",
+      "data-unsuited-applications": "Users may interact with a trained model to learn about a NBA game in a textual manner. On generated texts, they may observe factual errors that contradicts the actual data that the model conditions on.\nFactual errors include wrong statistics of a player (e.g., 3PT), non-existent injury information.",
+      "data-discouraged-use": "Publishing the generated text as is. Even if the model achieves high scores on the evaluation metrics, there is a risk of factual errors mentioned above."
+    }
+  },
+  "context": {
+    "previous": {
+      "is-deployed": "no",
+      "described-risks": "N/A",
+      "changes-from-observation": "N/A"
+    },
+    "underserved": {
+      "helps-underserved": "no",
+      "underserved-description": "N/A"
+    },
+    "biases": {
+      "has-biases": "no",
+      "bias-analyses": "N/A",
+      "speaker-distibution": "- English text in this dataset is from Rotowire, originally written by writers at Rotowire.com that are likely US-based.\n- German text is produced by professional translators proficient in both English and German."
+    }
+  }
+}