feat(default): add first version of PROST

README.md

@@ -0,0 +1,170 @@
+---
+annotations_creators:
+- expert-generated
+extended:
+- original
+language_creators:
+- expert-generated
+languages:
+- en-US
+licenses:
+- apache-2.0
+multilinguality:
+- monolingual
+paperswithcode_id: piqa
+size_categories:
+- 10K<n<100K
+source_datasets:
+- original
+task_categories:
+- question-answering
+task_ids:
+- multiple-choice-qa
+- open-domain-qa
+---
+
+# PROST: Physical Reasoning about Objects Through Space and Time
+
+## Table of Contents
+- [Table of Contents](#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:** 
+- **Repository:** https://github.com/nala-cub/prost
+- **Paper:** 
+- **Leaderboard:**
+- **Point of Contact:** [Stéphane Aroca-Ouellette](mailto:stephane.aroca-ouellette@colorado.edu), [Cory Paik](mailto:cory.paik@colorado.edu)
+
+### Dataset Summary
+*Physical Reasoning about Objects Through Space and Time* (PROST) is a probing dataset to evaluate the ability of pretrained LMs to understand and reason about the physical world. PROST consists of 18,736 cloze-style multiple choice questions from 14 manually curated templates, covering 10 physical reasoning concepts:  direction, mass, height, circumference, stackable, rollable, graspable, breakable, slideable, and bounceable. 
+
+
+### Supported Tasks and Leaderboards
+The task is multiple choice question answering, but you can formulate it multiple ways. You can use `context` and `question` to form cloze style questions, or `context` and `ex_question` as multiple choice question answering. See the [GitHub](https://github.com/nala-cub/prost) repo for examples using GPT-1, GPT-2, BERT, RoBERTa, ALBERT, T5, and UnifiedQA.
+
+### Languages
+The text in the dataset is in English. The associated BCP-47 code is `en-US`.
+
+## Dataset Structure
+
+### Data Instances
+An example looks like this:
+
+```json
+{
+  "A": "glass", 
+  "B": "pillow", 
+  "C": "coin", 
+  "D": "ball", 
+  "context": "A person drops a glass, a pillow, a coin, and a ball from a balcony.", 
+  "ex_question": "Which object is the most likely to break?", 
+  "group": "breaking", 
+  "label": 0, 
+  "name": "breaking_1", 
+  "question": "The [MASK] is the most likely to break."
+}
+```
+
+
+### Data Fields
+
+- `A`: Option A (0)
+- `B`: Option B (1)
+- `C`: Option C (2)
+- `D`: Option D (3)
+- `context`: Context for the question
+- `question`: A cloze style continuation of the context.
+- `ex_question`: A multiple-choice style question.
+- `group`: The question group, e.g. *bouncing*
+- `label`: A ClassLabel indication the correct option 
+- `example_idx`: an integer indicating the sorted example index.
+- `name':` The template identifier.
+
+### Data Splits
+
+The dataset contains 18,736 examples for testing.
+
+## Dataset Creation
+
+### Curation Rationale
+
+PROST is designed to avoid models succeeding in unintended ways. First, PROST provides no training data, so as to probe models in a zero-shot fashion. This prevents models from succeeding through spurious correlations between testing and training, and encourages success through a true understanding of and reasoning about the concepts at hand. Second, we manually write templates for all questions in an effort to prevent models from having seen the exact same sentences in their training data. Finally, it focuses on a small set of well defined, objective concepts that only require a small vocabulary. This allows researchers to focus more on the quality of training data rather than on size of it.
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## 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
+
+[More Information Needed]
+
+### Citation Information
+
+[More Information Needed]
+
+### Contributions
+
+Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.

prost.py

@@ -0,0 +1,69 @@
+# Copyright 2020 The HuggingFace Datasets Authors and Cory Paik
+#
+# 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.
+# ==============================================================================
+"""TODO: Add a description here."""
+
+import json
+import datasets
+
+# TODO: Add BibTeX citation
+# Find for instance the citation on arxiv or on the dataset repo/website
+_CITATION = """\
+"""
+
+# TODO: Add description of the dataset here
+# You can copy an official description
+_DESCRIPTION = """\
+"""
+_HOMEPAGE = 'https://github.com/nala-cub/prost'
+_LICENSE = 'Apache 2.0'
+
+_URL = 'https://huggingface.co/datasets/corypaik/prost/resolve/main/data'
+
+_URLs = {'default': f'{_URL}/default.jsonl'}
+
+MC_LABELS = list('ABCD')
+
+
+class Prost(datasets.GeneratorBasedBuilder):
+  """TODO: Short description of my dataset."""
+
+  VERSION = datasets.Version('1.0.0')
+
+  def _info(self):
+    features = datasets.Features({
+      'A': datasets.Value('string'),
+      'B': datasets.Value('string'),
+      'C': datasets.Value('string'),
+      'D': datasets.Value('string'),
+      'context': datasets.Value('string'),
+      'question': datasets.Value('string'),
+      'ex_question': datasets.Value('string'),
+      'group': datasets.Value('string'),
+      'label': datasets.ClassLabel(names=MC_LABELS),
+      'name': datasets.Value('string'),})
+    return datasets.DatasetInfo(description=_DESCRIPTION, features=features,
+                                supervised_keys=None, homepage=_HOMEPAGE,
+                                license=_LICENSE, citation=_CITATION)
+
+  def _split_generators(self, dl_manager):
+    """ Returns SplitGenerators."""
+    path = dl_manager.download_and_extract(_URLs[self.config.name])
+    kwargs = {'path': path}
+    return [datasets.SplitGenerator(datasets.Split.TEST, gen_kwargs=kwargs)]
+
+  def _generate_examples(self, path):
+    with open(path, 'r') as f:
+      for _id, line in enumerate(f.readlines()):
+        yield _id, json.loads(line)