Merge branch 'main' of https://huggingface.co/datasets/clips/mqa into main

README.md

@@ -60,9 +60,9 @@ task_ids:
 ---
 # MQA
 MQA is a Multilingual corpus of Questions and Answers (MQA) parsed from the [Common Crawl](https://commoncrawl.org/). Questions are divided in two types: *Frequently Asked Questions (FAQ)* and *Community Question Answering (CQA)*.
-```
+```python
 from datasets import load_dataset
-all = load_dataset("clips/mqa", language="en")
+all_data = load_dataset("clips/mqa", language="en")
 {
   "name": "the title of the question (if any)",
   "text": "the body of the question (if any)",
@@ -71,13 +71,13 @@ all = load_dataset("clips/mqa", language="en")
     "is_accepted": "true|false"
   }]
 }
-faq = load_dataset("clips/mqa", scope="faq", language="en")
-cqa = load_dataset("clips/mqa", scope="cqa", language="en")
+faq_data = load_dataset("clips/mqa", scope="faq", language="en")
+cqa_data = load_dataset("clips/mqa", scope="cqa", language="en")
 ```
 
 ## Languages
 We collected around **234M pairs** of questions and answers in **39 languages**. To download a language specific subset you need to specify the language key as configuration. See below for an example.
-```
+```python
 load_dataset("clips/mqa", language="en") # replace "en" by any language listed below
 ```
 
@@ -126,7 +126,7 @@ load_dataset("clips/mqa", language="en") # replace "en" by any language listed b
 ## FAQ vs. CQA
 You can download the *Frequently Asked Questions* (FAQ) or the *Community Question Answering* (CQA) part of the dataset.
 
-```
+```python
 faq = load_dataset("clips/mqa", scope="faq")
 cqa = load_dataset("clips/mqa", scope="cqa")
 all = load_dataset("clips/mqa", scope="all")
@@ -136,27 +136,27 @@ Although FAQ and CQA questions share the same structure, CQA questions can have
 ## Nesting and Data Fields
 You can specify three different nesting level: `question`, `page` and `domain`.
 #### Question
-```
+```python
 load_dataset("clips/mqa", level="question") # default
 ```
 The default level is the question object:
-- **name**: the title of the question (if any)
-- **text**: the body of the question (if any)
+- **name**: the title of the question(if any) in markdown format 
+- **text**: the body of the question (if any) in markdown format
 - **answers**: a list of answers
-    - **text**: the title of the answer (if any)
-    - **name**: the body of the answer
+    - **text**: the title of the answer (if any) in markdown format
+    - **name**: the body of the answer in markdown format
     - **is_accepted**: true if the answer is selected.
 
 #### Page
 This level returns a list of questions present on the same page. This is mostly useful for FAQs since CQAs already have one question per page.
-```
+```python
 load_dataset("clips/mqa", level="page")
 ```
 
 #### Domain
 This level returns a list of pages present on the web domain. This is a good way to cope with FAQs duplication by sampling one page per domain at each epoch.
 
-```
+```python
 load_dataset("clips/mqa", level="domain")
 ```
 
@@ -187,10 +187,19 @@ We will comply to legitimate requests by removing the affected sources from the
 
 ## Citation information
 ```
-@misc{debruyn2021mfaq,
-      title={MFAQ: a Multilingual FAQ Dataset}, 
-      author={Maxime {De Bruyn} and Ehsan Lotfi and Jeska Buhmann and Walter Daelemans},
-      year={2021},
-      booktitle={MRQA@EMNLP2021},
+@inproceedings{de-bruyn-etal-2021-mfaq,
+    title = "{MFAQ}: a Multilingual {FAQ} Dataset",
+    author = "De Bruyn, Maxime  and
+      Lotfi, Ehsan  and
+      Buhmann, Jeska  and
+      Daelemans, Walter",
+    booktitle = "Proceedings of the 3rd Workshop on Machine Reading for Question Answering",
+    month = nov,
+    year = "2021",
+    address = "Punta Cana, Dominican Republic",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2021.mrqa-1.1",
+    pages = "1--13",
 }
+
 ```