Update files from the datasets library (from 1.18.0)

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

README.md

@@ -6,7 +6,7 @@ language_creators:
 languages:
 - en
 licenses:
-- unknown
+- cc-by-sa-4-0
 multilinguality:
 - monolingual
 size_categories:
@@ -18,6 +18,7 @@ task_categories:
 task_ids:
 - open-domain-qa
 paperswithcode_id: tweetqa
+pretty_name: TweetQA
 ---
 
 # Dataset Card for TweetQA
@@ -48,74 +49,87 @@ paperswithcode_id: tweetqa
 
 ## Dataset Description
 
-- **Homepage: [TweetQA homepage](https://tweetqa.github.io/)**
-- **Repository: **
-- **Paper: [TweetQA paper]([TweetQA repository](https://tweetqa.github.io/)**
-- **Leaderboard:**
-- **Point of Contact: [Wenhan Xiong]([email protected])**
+- **Homepage:** [TweetQA homepage](https://tweetqa.github.io/)
+- **Repository:**
+- **Paper:** [TWEETQA: A Social Media Focused Question Answering Dataset](https://arxiv.org/abs/1907.06292)
+- **Leaderboard:** [TweetQA Leaderboard](https://tweetqa.github.io/)
+- **Point of Contact:** [Wenhan Xiong]([email protected])
 
 ### Dataset Summary
 
+With social media becoming increasingly popular on which lots of news and real-time events are reported, developing automated question answering systems is critical to the effectiveness of many applications that rely on real-time knowledge. While previous question answering (QA) datasets have concentrated on formal text like news and Wikipedia, the first large-scale dataset for QA over social media data is presented. To make sure the tweets are meaningful and contain interesting information, tweets used by journalists to write news articles are gathered. Then human annotators are asked to write questions and answers upon these tweets. Unlike other QA datasets like SQuAD in which the answers are extractive, the answer are allowed to be abstractive. The task requires model to read a short tweet and a question and outputs a text phrase (does not need to be in the tweet) as the answer.
 
 ### Supported Tasks and Leaderboards
 
-[More Information Needed]
+- `question-answering`: The dataset can be used to train a model for Open-Domain Question Answering where the task is to answer the given questions for a tweet. The performance is measured by comparing the model answers to the the annoted groundtruth and calculating the BLEU-1/Meteor/ROUGE-L score. This task has an active leaderboard which can be found [here](https://tweetqa.github.io/) and ranks models based on [BLEU-1](https://huggingface.co/metrics/blue), [Meteor](https://huggingface.co/metrics/meteor) and [ROUGLE-L](https://huggingface.co/metrics/rouge).
 
 ### Languages
 
-[More Information Needed]
+English.
 
 ## Dataset Structure
 
 ### Data Instances
+
 Sample data:
+
 ```
 {
-    "Question": "who is the tallest host?",
-    "Answer": ["sam bee","sam bee"],
-    "Tweet": "Don't believe @ConanOBrien's height lies. Sam Bee is the tallest host in late night. #alternativefacts\u2014 Full Frontal (@FullFrontalSamB) January 22, 2017",
-    "qid": "3554ee17d86b678be34c4dc2c04e334f"
+  "Question": "who is the tallest host?",
+  "Answer": ["sam bee","sam bee"],
+  "Tweet": "Don't believe @ConanOBrien's height lies. Sam Bee is the tallest host in late night. #alternativefacts\u2014 Full Frontal (@FullFrontalSamB) January 22, 2017",
+  "qid": "3554ee17d86b678be34c4dc2c04e334f"
 }
 ```
+
+The test split doesn't include answers so the Answer field is an empty list.
+
 ### Data Fields
 
-Question: a question based on information from a tweet
-Answer: list of possible answers from the tweet
-Tweet: source tweet
-qid: question id
+- `Question`: a question based on information from a tweet
+- `Answer`: list of possible answers from the tweet
+- `Tweet`: source tweet
+- `qid`: question id
 
 ### Data Splits
 
-The dataset is split in train, validation and test.
-The test split doesn't include answers so the Answer field is an empty list.
-
-[More Information Needed]
+The dataset is split in train, validation and test set. The train set cointains 10692 examples, the validation set 1086 and the test set 1979 examples.
 
 ## Dataset Creation
 
 ### Curation Rationale
 
-With social media becoming increasingly popular on which lots of news and real-time events are reported, developing automated question answering systems is critical to the effectiveness of many applications that rely on realtime knowledge. While previous datasets have concentrated on question answering (QA) for formal text like news and Wikipedia, we present the first large-scale dataset for QA over social media data. To ensure that the tweets we collected are useful, we only gather tweets used by journalists to write news articles. We then ask human annotators to write questions and answers upon these tweets. Unlike other QA datasets like SQuAD in which the answers are extractive, we allow the answers to be abstractive
+With social media becoming increasingly popular on which lots of news and real-time events are reported, developing automated question answering systems is critical to the effectiveness of many applications that rely on real-time knowledge. While previous question answering (QA) datasets have concentrated on formal text like news and Wikipedia, the first large-scale dataset for QA over social media data is presented. To make sure the tweets are meaningful and contain interesting information, tweets used by journalists to write news articles are gathered. Then human annotators are asked to write questions and answers upon these tweets. Unlike other QA datasets like SQuAD in which the answers are extractive, the answer are allowed to be abstractive. The task requires model to read a short tweet and a question and outputs a text phrase (does not need to be in the tweet) as the answer.
 
 ### Source Data
 
 #### Initial Data Collection and Normalization
 
-We first describe the three-step data collection process of TWEETQA: tweet crawling, question-answer writing and answer validation.  Next, we define the specific task of TWEETQA and discuss several evaluation metrics. To better understand the characteristics of the TWEETQA task, we also include our analysis on the answer and question characteristics using a subset of QA pairs from the development set.
+The authors look into the the archived snapshots of two major news websites (CNN, NBC), and then extract the tweet blocks that are embedded in the news articles. In order to get enough data, they first extract the URLs of all section pages (e.g. World, Politics, Money, Tech) from the snapshot of each home page and then crawl all articles with tweets from these section pages. Then, they filter out the tweets that heavily rely on attached media to convey information, for which they utilize a state-of-the-art semantic role labeling model trained on CoNLL-2005 (He et al., 2017) to analyze the predicate-argument structure of the tweets collected from news articles and keep
+only the tweets with more than two labeled arguments. This filtering process also automatically
+filters out most of the short tweets. For the tweets collected from CNN, 22.8% of them were filtered
+via semantic role labeling. For tweets from NBC, 24.1% of the tweets were filtered.
 
 #### Who are the source language producers?
 
-[More Information Needed]
+Twitter users.
 
 ### Annotations
 
 #### Annotation process
 
-[More Information Needed]
+The Amazon Mechanical Turk workers were used to collect question-answer
+pairs for the filtered tweets. For each Human Intelligence Task (HIT), the authors ask the worker to read three tweets and write two question-answer pairs for each tweet. To ensure the quality, they require the workers to be located in major English speaking countries (i.e. Canada, US, and UK) and have an acceptance rate larger than 95%. Since the authors use tweets as context, lots of important information are contained in hashtags or even emojis. Instead of only showing the text to the workers, they use javascript to directly embed the whole tweet into each HIT. This gives workers the same experience as reading tweets via web browsers and help them to better compose questions. To avoid trivial questions that can be simply answered by superficial text matching methods or too challenging questions that require background knowledge, the authors explicitly state the following items in the HIT instructions for question writing:
+- No Yes-no questions should be asked.
+- The question should have at least five words.
+- Videos, images or inserted links should not
+be considered.
+- No background knowledge should be required to answer the question.
+To help the workers better follow the instructions, they also include a representative example showing both good and bad questions or answers in the instructions. As for the answers, since the context they consider is relatively shorter than the context of previous datasets, they do not restrict the answers to be in the tweet, otherwise, the task may potentially be simplified as a classification problem. The workers are allowed to write their answers in their own words, but the authors require the answers to be brief and can be directly inferred from the tweets. After they retrieve the QA pairs from all HITs, they conduct further post-filtering to filter out the pairs from workers that obviously do not follow instructions. They remove QA pairs with yes/no answers. Questions with less than five words are also filtered out. This process filtered 13% of the QA pairs. The dataset now includes 10,898 articles, 17,794 tweets, and 13,757 crowdsourced question-answer pairs. All QA pairs were written by 492 individual workers. 
 
 #### Who are the annotators?
 
-[More Information Needed]
+Amazon Mechanical Turk workers.
 
 ### Personal and Sensitive Information
 
@@ -129,7 +143,13 @@ We first describe the three-step data collection process of TWEETQA: tweet crawl
 
 ### Discussion of Biases
 
-[More Information Needed]
+From the paper:
+> It is also worth noting that the data collected from social media can not only capture events and developments in real-time but also capture individual opinions and thus requires reasoning related to the authorship of the content as is illustrated in Table 1.
+
+> Specifically, a significant amount of questions require certain reasoning skills that are specific to social media data:
+- Understanding authorship: Since tweets are highly personal, it is critical to understand how questions/tweets related to the authors.
+- Oral English & Tweet English: Tweets are often oral and informal. QA over tweets requires the understanding of common oral English. Our TWEETQA also requires understanding some tweet-specific English, like conversation-style English.
+- Understanding of user IDs & hashtags: Tweets often contains user IDs and hashtags, which are single special tokens. Understanding these special tokens is important to answer person- or event-related questions.
 
 ### Other Known Limitations
 
@@ -137,25 +157,28 @@ We first describe the three-step data collection process of TWEETQA: tweet crawl
 
 ## Additional Information
 
+The annotated answers are validated by the authors as follows:
+For the purposes of human performance evaluation and inter-annotator agreement checking, the authors launch a different set of HITs to ask workers to answer questions in the test and development set. The workers are shown with the tweet blocks as well as the questions collected in the previous step. At this step, workers are allowed to label the questions as “NA” if they think the questions are not answerable. They find that 3.1% of the questions are labeled as unanswerable by the workers (for SQuAD, the ratio is 2.6%). Since the answers collected at this step and previous step are written by different workers, the answers can be written in different text forms even they are semantically equal to each other. For example, one answer can be “Hillary Clinton” while the other is “@HillaryClinton”. As it is not straightforward to automatically calculate the overall agreement, they manually check the agreement on a subset of 200 random samples from the development set and ask an independent human moderator to verify the result. It turns out that 90% of the answers pairs are semantically equivalent, 2% of them are partially equivalent (one of them is incomplete) and 8% are totally inconsistent. The answers collected at this step are also used to measure the human performance. 59 individual workers participated in this process.
+
 ### Dataset Curators
 
-[Wenhan Xiong]([email protected]) of UCSB
+Xiong, Wenhan and Wu, Jiawei and Wang, Hong and Kulkarni, Vivek and Yu, Mo and Guo, Xiaoxiao and Chang, Shiyu and Wang, William Yang.
 
 ### Licensing Information
 
-[More Information Needed]
+CC BY-SA 4.0.
 
 ### Citation Information
 
-@misc{xiong2019tweetqa,
-      title={TWEETQA: A Social Media Focused Question Answering Dataset},
-      author={Wenhan Xiong and Jiawei Wu and Hong Wang and Vivek Kulkarni and Mo Yu and Shiyu Chang and Xiaoxiao Guo and William Yang Wang},
-      year={2019},
-      eprint={1907.06292},
-      archivePrefix={arXiv},
-      primaryClass={cs.CL}
+```
+@inproceedings{xiong2019tweetqa,
+  title={TweetQA: A Social Media Focused Question Answering Dataset},
+  author={Xiong, Wenhan and Wu, Jiawei and Wang, Hong and Kulkarni, Vivek and Yu, Mo and Guo, Xiaoxiao and Chang, Shiyu and Wang, William Yang},
+  booktitle={Proceedings of the 57th Annual Meeting of the Association for Computational Linguistics},
+  year={2019}
 }
+```
 
 ### Contributions
 
-Thanks to [@anaerobeth](https://github.com/anaerobeth) for adding this dataset.
+Thanks to [@anaerobeth](https://github.com/anaerobeth) for adding this dataset.

dataset_infos.json

@@ -1 +1 @@
-{"default": {"description": " TweetQA is the first dataset for QA on social media data by leveraging news media and crowdsourcing.\n", "citation": "@misc{xiong2019tweetqa,\n      title={TWEETQA: A Social Media Focused Question Answering Dataset},\n      author={Wenhan Xiong and Jiawei Wu and Hong Wang and Vivek Kulkarni and Mo Yu and Shiyu Chang and Xiaoxiao Guo and William Yang Wang},\n      year={2019},\n      eprint={1907.06292},\n      archivePrefix={arXiv},\n      primaryClass={cs.CL}\n}\n", "homepage": "https://tweetqa.github.io/", "license": "CC BY-SA 4.0", "features": {"Question": {"dtype": "string", "id": null, "_type": "Value"}, "Answer": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "Tweet": {"dtype": "string", "id": null, "_type": "Value"}, "qid": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "builder_name": "tweet_qa", "config_name": "default", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 3386268, "num_examples": 10692, "dataset_name": "tweet_qa"}, "test": {"name": "test", "num_bytes": 473734, "num_examples": 1979, "dataset_name": "tweet_qa"}, "validation": {"name": "validation", "num_bytes": 408535, "num_examples": 1086, "dataset_name": "tweet_qa"}}, "download_checksums": {"https://sites.cs.ucsb.edu/~xwhan/datasets/tweetqa.zip": {"num_bytes": 1573980, "checksum": "e0db1b71836598aaea8785f1911369b5bca0d839504b97836eb5cb7427c7e4d9"}}, "download_size": 1573980, "post_processing_size": null, "dataset_size": 4268537, "size_in_bytes": 5842517}}
+{"default": {"description": "TweetQA is the first dataset for QA on social media data by leveraging news media and crowdsourcing.\n", "citation": "@inproceedings{xiong2019tweetqa,\n  title={TweetQA: A Social Media Focused Question Answering Dataset},\n  author={Xiong, Wenhan and Wu, Jiawei and Wang, Hong and Kulkarni, Vivek and Yu, Mo and Guo, Xiaoxiao and Chang, Shiyu and Wang, William Yang},\n  booktitle={Proceedings of the 57th Annual Meeting of the Association for Computational Linguistics},\n  year={2019}\n}\n", "homepage": "https://tweetqa.github.io/", "license": "CC BY-SA 4.0", "features": {"Question": {"dtype": "string", "id": null, "_type": "Value"}, "Answer": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "Tweet": {"dtype": "string", "id": null, "_type": "Value"}, "qid": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "tweet_qa", "config_name": "default", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 2770036, "num_examples": 10692, "dataset_name": "tweet_qa"}, "test": {"name": "test", "num_bytes": 473730, "num_examples": 1979, "dataset_name": "tweet_qa"}, "validation": {"name": "validation", "num_bytes": 295435, "num_examples": 1086, "dataset_name": "tweet_qa"}}, "download_checksums": {"https://sites.cs.ucsb.edu/~xwhan/datasets/tweetqa.zip": {"num_bytes": 1573980, "checksum": "e0db1b71836598aaea8785f1911369b5bca0d839504b97836eb5cb7427c7e4d9"}}, "download_size": 1573980, "post_processing_size": null, "dataset_size": 3539201, "size_in_bytes": 5113181}}

tweet_qa.py

@@ -22,18 +22,16 @@ import datasets
 
 
 _CITATION = """\
-@misc{xiong2019tweetqa,
-      title={TWEETQA: A Social Media Focused Question Answering Dataset},
-      author={Wenhan Xiong and Jiawei Wu and Hong Wang and Vivek Kulkarni and Mo Yu and Shiyu Chang and Xiaoxiao Guo and William Yang Wang},
-      year={2019},
-      eprint={1907.06292},
-      archivePrefix={arXiv},
-      primaryClass={cs.CL}
+@inproceedings{xiong2019tweetqa,
+  title={TweetQA: A Social Media Focused Question Answering Dataset},
+  author={Xiong, Wenhan and Wu, Jiawei and Wang, Hong and Kulkarni, Vivek and Yu, Mo and Guo, Xiaoxiao and Chang, Shiyu and Wang, William Yang},
+  booktitle={Proceedings of the 57th Annual Meeting of the Association for Computational Linguistics},
+  year={2019}
 }
 """
 
 _DESCRIPTION = """\
- TweetQA is the first dataset for QA on social media data by leveraging news media and crowdsourcing.
+TweetQA is the first dataset for QA on social media data by leveraging news media and crowdsourcing.
 """
 
 _HOMEPAGE = "https://tweetqa.github.io/"
@@ -101,12 +99,12 @@ class TweetQA(datasets.GeneratorBasedBuilder):
 
         with open(filepath, encoding="utf-8") as f:
             tweet_qa = json.load(f)
+            idx = 0
             for data in tweet_qa:
-                id_ = data["qid"]
-
-                yield id_, {
+                yield idx, {
                     "Question": data["Question"],
                     "Answer": [] if split == "test" else data["Answer"],
                     "Tweet": data["Tweet"],
                     "qid": data["qid"],
                 }
+                idx += 1