Update README.md

README.md

@@ -19,17 +19,20 @@ size_categories:
 ## Dataset Description
 
 - **Homepage:** 
-- **Repository:**
- https://github.com/bernardoleite/fairytaleqa-translated
-- **Paper:**
- https://aclanthology.org/
-- **Leaderboard:** 
-- **Point of Contact:**
-  Bernardo Leite (benjleite.com)
+- **Repository:** https://github.com/bernardoleite/fairytaleqa-translated
+- **Paper:** https://arxiv.org/abs/2406.04233v1
+- **Leaderboard:** https://paperswithcode.com/sota/question-generation-on-fairytaleqa
+- **Point of Contact:** Bernardo Leite (benjleite.com)
 
 ### Dataset Summary
 
-This repository contains the European Portuguese (pt-PT) machine-translated version of the original English FairytaleQA dataset (https://huggingface.co/datasets/WorkInTheDark/FairytaleQA). FairytaleQA is an open-source dataset designed to enhance comprehension of narratives, aimed at students from kindergarten to eighth grade. The dataset is meticulously annotated by education experts following an evidence-based theoretical framework. It comprises 10,580 explicit and implicit questions derived from 278 child-friendly stories, covering seven types of narrative elements or relations.
+This repository contains the **European Portuguese (pt-PT)** machine-translated version of the original English FairytaleQA dataset (https://huggingface.co/datasets/WorkInTheDark/FairytaleQA). FairytaleQA is an open-source dataset designed to enhance comprehension of narratives, aimed at students from kindergarten to eighth grade. The dataset is meticulously annotated by education experts following an evidence-based theoretical framework. It comprises 10,580 explicit and implicit questions derived from 278 child-friendly stories, covering seven types of narrative elements or relations.
+
+You can load the dataset via:
+```
+import datasets
+data = datasets.load_dataset('benjleite/FairytaleQA-translated-ptPT')
+```
 
 ### Supported Tasks and Leaderboards
 
@@ -39,22 +42,40 @@ Question-Answering, Question-Generation, Question-Answer Pair Generation
 
 European Portuguese (pt-PT)
 
-### Data Instances
+### Example
 
 An example of "train" looks as follows:
 
 ```
 {
-  'story_name': 'golden-goose-story',
-  'story_section': 'Era uma vez um homem que tinha três filhos. O mais novo chamava-se
-                      ... ...
-                    que tens no bolso e deixa-me beber um pouco do teu vinho - tenho tanta fome e sede.',
-  'question': 'Porque é que a mãe deu ao mais velho um belo bolo e uma garrafa de vinho?',
-  'answer': 'Para que não sofresse de fome ou sede.',
+  'story_name': 'the-toad-woman-story',
+  'story_section': 'Uma vez aconteceu uma grande sorte a uma jovem que vivia sozinha no bosque...'
+  'question': 'Quem é que a mulher viu a deslizar para a floresta?',
+  'answer': 'Um jovem bonito.',
   'local-or-sum': 'local',
-  'attribute': 'causal',
+  'attribute': 'character',
   'ex-or-im': 'explicit',
-  'ex-or-im2': 'explicit',
+  'ex-or-im2': '',
 }
+```
+
+### Dataset Structure
+
+- `story_name`*: a string of the story name to which the story section content belongs.
+
+- `story_section`: a string of the story section(s) content related to the experts' labeled QA-pair. Used as the input for both Question Generation and Question Answering tasks.  
+
+- `question`: a string of the question content. Used as the input for Question Answering task and as the output for Question Generation task.  
+
+- `answer`: a string of the answer content for all splits. Used as the input for Question Generation task and as the output for Question Answering task.
+
+- `local_or_sum`*: a string of either local or summary, indicating whether the QA is related to one story section or multiple sections.
+
+- `attribute`*: a string of one of character, causal relationship, action, setting, feeling, prediction, or outcome resolution. Classification of the QA by education experts annotators via 7 narrative elements on an established framework.
+ 
+- `ex_or_im1`*: a string of either explicit or implicit, indicating whether the answers can be directly found in the story content or cannot be directly from the story content.
+
+- `ex_or_im2`*: similar to 'ex-or-im1', but annotated by another annotator (only available for test/val splits).
+
 
-```
+(*) Field has not been translated. Use it at your own convenince.