Update README.md

README.md

@@ -1,3 +1,301 @@
----
-license: openrail
----
+---
+annotations_creators:
+- crowdsourced
+- expert-generated
+language_creators:
+- expert-generated
+language:
+- en
+license:
+- unknown
+multilinguality:
+- monolingual
+size_categories:
+- 1K<n<10K
+source_datasets:
+- original
+task_categories:
+- question-answering
+task_ids:
+- open-domain-qa
+paperswithcode_id: openbookqa
+pretty_name: OpenBookQA
+dataset_info:
+- config_name: additional
+  features:
+  - name: id
+    dtype: string
+  - name: question_stem
+    dtype: string
+  - name: choices
+    sequence:
+    - name: text
+      dtype: string
+    - name: label
+      dtype: string
+  - name: answerKey
+    dtype: string
+  - name: fact1
+    dtype: string
+  - name: humanScore
+    dtype: float32
+  - name: clarity
+    dtype: float32
+  - name: turkIdAnonymized
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 1288577
+    num_examples: 4957
+  - name: validation
+    num_bytes: 135916
+    num_examples: 500
+  - name: test
+    num_bytes: 130701
+    num_examples: 500
+  download_size: 783789
+  dataset_size: 1555194
+- config_name: main
+  features:
+  - name: id
+    dtype: string
+  - name: question_stem
+    dtype: string
+  - name: choices
+    sequence:
+    - name: text
+      dtype: string
+    - name: label
+      dtype: string
+  - name: answerKey
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 895386
+    num_examples: 4957
+  - name: validation
+    num_bytes: 95428
+    num_examples: 500
+  - name: test
+    num_bytes: 91759
+    num_examples: 500
+  download_size: 609613
+  dataset_size: 1082573
+configs:
+- config_name: additional
+  data_files:
+  - split: train
+    path: additional/train-*
+  - split: validation
+    path: additional/validation-*
+  - split: test
+    path: additional/test-*
+- config_name: main
+  data_files:
+  - split: train
+    path: main/train-*
+  - split: validation
+    path: main/validation-*
+  - split: test
+    path: main/test-*
+  default: true
+---
+
+# Dataset Card for OpenBookQA
+
+## 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://allenai.org/data/open-book-qa](https://allenai.org/data/open-book-qa)
+- **Repository:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+- **Paper:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+- **Point of Contact:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+- **Size of downloaded dataset files:** 2.89 MB
+- **Size of the generated dataset:** 2.88 MB
+- **Total amount of disk used:** 5.78 MB
+
+### Dataset Summary
+
+OpenBookQA aims to promote research in advanced question-answering, probing a deeper understanding of both the topic
+(with salient facts summarized as an open book, also provided with the dataset) and the language it is expressed in. In
+particular, it contains questions that require multi-step reasoning, use of additional common and commonsense knowledge,
+and rich text comprehension.
+OpenBookQA is a new kind of question-answering dataset modeled after open book exams for assessing human understanding of
+a subject.
+
+### Supported Tasks and Leaderboards
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Languages
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+## Dataset Structure
+
+### Data Instances
+
+#### main
+
+- **Size of downloaded dataset files:** 1.45 MB
+- **Size of the generated dataset:** 1.45 MB
+- **Total amount of disk used:** 2.88 MB
+
+An example of 'train' looks as follows:
+```
+{'id': '7-980',
+ 'question_stem': 'The sun is responsible for',
+ 'choices': {'text': ['puppies learning new tricks',
+   'children growing up and getting old',
+   'flowers wilting in a vase',
+   'plants sprouting, blooming and wilting'],
+  'label': ['A', 'B', 'C', 'D']},
+ 'answerKey': 'D'}
+```
+
+#### additional
+
+- **Size of downloaded dataset files:** 1.45 MB
+- **Size of the generated dataset:** 1.45 MB
+- **Total amount of disk used:** 2.88 MB
+
+An example of 'train' looks as follows:
+```
+{'id': '7-980',
+ 'question_stem': 'The sun is responsible for',
+ 'choices': {'text': ['puppies learning new tricks',
+   'children growing up and getting old',
+   'flowers wilting in a vase',
+   'plants sprouting, blooming and wilting'],
+  'label': ['A', 'B', 'C', 'D']},
+ 'answerKey': 'D',
+ 'fact1': 'the sun is the source of energy for physical cycles on Earth',
+ 'humanScore': 1.0,
+ 'clarity': 2.0,
+ 'turkIdAnonymized': 'b356d338b7'}
+```
+
+### Data Fields
+
+The data fields are the same among all splits.
+
+#### main
+- `id`: a `string` feature.
+- `question_stem`: a `string` feature.
+- `choices`: a dictionary feature containing:
+  - `text`: a `string` feature.
+  - `label`: a `string` feature.
+- `answerKey`: a `string` feature.
+
+#### additional
+- `id`: a `string` feature.
+- `question_stem`: a `string` feature.
+- `choices`: a dictionary feature containing:
+  - `text`: a `string` feature.
+  - `label`: a `string` feature.
+- `answerKey`: a `string` feature.
+- `fact1` (`str`): oOriginating common knowledge core fact associated to the question.
+- `humanScore` (`float`): Human accuracy score.
+- `clarity` (`float`): Clarity score.
+- `turkIdAnonymized` (`str`): Anonymized crowd-worker ID.
+
+### Data Splits
+
+| name       | train | validation | test |
+|------------|------:|-----------:|-----:|
+| main       |  4957 |        500 |  500 |
+| additional |  4957 |        500 |  500 |
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+#### Who are the source language producers?
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+#### Who are the annotators?
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Personal and Sensitive Information
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Discussion of Biases
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Other Known Limitations
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Licensing Information
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Citation Information
+
+```
+@inproceedings{OpenBookQA2018,
+ title={Can a Suit of Armor Conduct Electricity? A New Dataset for Open Book Question Answering},
+ author={Todor Mihaylov and Peter Clark and Tushar Khot and Ashish Sabharwal},
+ booktitle={EMNLP},
+ year={2018}
+}
+
+```
+
+
+### Contributions
+
+Thanks to [@thomwolf](https://github.com/thomwolf), [@patrickvonplaten](https://github.com/patrickvonplaten), [@lewtun](https://github.com/lewtun) for adding this dataset.