Finished README

README.md

@@ -32,6 +32,7 @@ task_ids:
   - [Dataset Structure](#dataset-structure)
     - [Data Instances](#data-instances)
     - [Data Splits](#data-splits)
+    - [Data Example](#data-example)
     - [Dataset Creation](#dataset-creation)
   - [Additional Information](#additional-information)
     - [Dataset Curators](#dataset-curators)
@@ -51,49 +52,34 @@ The intended usage of this corpus is restricted to the scope of final project fo
 The language data of this corpus is in English (BCP-47 `en`) and Dutch (BCP-47 `nl`).
 ## Dataset Structure
 ### Data Instances
-The dataset contains a single configuration, named `plain_text`, containing the following fields:
 
-- `premise_en`: The original English premise.
-
-- `premise_nl`: The premise automatically translated to Dutch.
-
-- `hypothesis_en`: The original English hypothesis.
-
-- `hypothesis_nl`: The hypothesis automatically translated to Dutch.
-
-- `label`: The label of the data instance (0 for entailment, 1 for neutral, 2 for contradiction).
-
-- `explanation_1_en`: The first explanation for the assigned label in English.
-
-- `explanation_1_nl`: The first explanation automatically translated to Dutch.
-
-- `explanation_2_en`: The second explanation for the assigned label in English.
-
-- `explanation_2_nl`: The second explanation automatically translated to Dutch.
-
-- `explanation_3_en`: The third explanation for the assigned label in English.
-
-- `explanation_3_nl`: The third explanation automatically translated to Dutch.
-
-- `da_premise`: The quality estimation produced by the `wmt20-comet-qe-da` model for the premise translation.
-
-- `da_hypothesis`: The quality estimation produced by the `wmt20-comet-qe-da` model for the hypothesis translation.
-
-- `da_explanation_1`: The quality estimation produced by the `wmt20-comet-qe-da` model for the first explanation translation.
-
-- `da_explanation_2`: The quality estimation produced by the `wmt20-comet-qe-da` model for the second explanation translation.
-
-- `da_explanation_3`: The quality estimation produced by the `wmt20-comet-qe-da` model for the third explanation translation.
-
-- `mqm_premise`: The quality estimation produced by the `wmt21-comet-qe-mqm` model for the premise translation.
-
-- `mqm_hypothesis`: The quality estimation produced by the `wmt21-comet-qe-mqm` model for the hypothesis translation.
-
-- `mqm_explanation_1`: The quality estimation produced by the `wmt21-comet-qe-mqm` model for the first explanation translation.
-
-- `mqm_explanation_2`: The quality estimation produced by the `wmt21-comet-qe-mqm` model for the second explanation translation.
-
-- `mqm_explanation_3`: The quality estimation produced by the `wmt21-comet-qe-mqm` model for the third explanation translation.
+The dataset contains a single condiguration by default, named `plain_text`, with the three original splits `train`, `validation` and `test`. Every split contains the following fields:
+
+| **Field** | **Description** |
+|------------|-----------------------------|
+|`premise_en`| The original English premise.|
+|`premise_nl`| The premise automatically translated to Dutch.|
+|`hypothesis_en`| The original English hypothesis.|
+|`hypothesis_nl`| The hypothesis automatically translated to Dutch.|
+|`label`| The label of the data instance (0 for entailment, 1 for neutral, 2 for contradiction).|
+|`explanation_1_en`| The first explanation for the assigned label in English.|
+|`explanation_1_nl`| The first explanation automatically translated to Dutch.|
+|`explanation_2_en`| The second explanation for the assigned label in English.|
+|`explanation_2_nl`| The second explanation automatically translated to Dutch.|
+|`explanation_3_en`| The third explanation for the assigned label in English.|
+|`explanation_3_nl`| The third explanation automatically translated to Dutch.|
+|`da_premise`| The quality estimation produced by the `wmt20-comet-qe-da` model for the premise translation.|
+|`da_hypothesis`| The quality estimation produced by the `wmt20-comet-qe-da` model for the hypothesis translation.|
+|`da_explanation_1`| The quality estimation produced by the `wmt20-comet-qe-da` model for the first explanation translation.|
+|`da_explanation_2`| The quality estimation produced by the `wmt20-comet-qe-da` model for the second explanation translation.|
+|`da_explanation_3`| The quality estimation produced by the `wmt20-comet-qe-da` model for the third explanation translation.|
+|`mqm_premise`| The quality estimation produced by the `wmt21-comet-qe-mqm` model for the premise translation.|
+|`mqm_hypothesis`| The quality estimation produced by the `wmt21-comet-qe-mqm` model for the hypothesis translation.|
+|`mqm_explanation_1`| The quality estimation produced by the `wmt21-comet-qe-mqm` model for the first explanation translation.|
+|`mqm_explanation_2`| The quality estimation produced by the `wmt21-comet-qe-mqm` model for the second explanation translation.|
+|`mqm_explanation_3`| The quality estimation produced by the `wmt21-comet-qe-mqm` model for the third explanation translation.|
+
+Explanation 2 and 3 and related quality estimation scores are only present in the `validation` and `test` splits.
 
 ### Data Splits
 
@@ -103,6 +89,36 @@ The dataset contains a single configuration, named `plain_text`, containing the
 
 For your analyses, use the amount of data that is the most reasonable for your computational setup. The more, the better.
 
+### Data Example
+
+The following is an example of entry 2000 taken from the `test` split:
+
+```json
+{
+  "premise_en": "A young woman wearing a yellow sweater and black pants is ice skating outdoors.",
+  "premise_nl": "Een jonge vrouw met een gele trui en zwarte broek schaatst buiten.",
+  "hypothesis_en": "a woman is practicing for the olympics",
+  "hypothesis_nl": "een vrouw oefent voor de Olympische Spelen",
+  "label": 1,
+  "explanation_1_en": "You can not infer it's for the Olympics.",
+  "explanation_1_nl": "Het is niet voor de Olympische Spelen.",
+  "explanation_2_en": "Just because a girl is skating outdoors does not  mean she is practicing for the Olympics.",
+  "explanation_2_nl": "Alleen omdat een meisje buiten schaatst betekent niet dat ze oefent voor de Olympische Spelen.",
+  "explanation_3_en": "Ice skating doesn't imply practicing for the olympics.",
+  "explanation_3_nl": "Schaatsen betekent niet oefenen voor de Olympische Spelen.",
+  "da_premise": "0.6099",
+  "mqm_premise": "0.1298",
+  "da_hypothesis": "0.8504",
+  "mqm_hypothesis": "0.1521",
+  "da_explanation_1": "0.0001",
+  "mqm_explanation_1": "0.1237",
+  "da_explanation_2": "0.4017",
+  "mqm_explanation_2": "0.1467",
+  "da_explanation_3": "0.6069",
+  "mqm_explanation_3": "0.1389"
+}
+```
+
 ### Dataset Creation
 
 The dataset was created through the following steps: