Create README.md

README.md

@@ -0,0 +1,415 @@
+---
+task_categories:
+- question-answering
+language:
+- en
+- fr
+- de
+- it
+- es
+- pt
+pretty_name: mTRECQA
+size_categories:
+- 100K<n<1M
+configs:
+- config_name: default
+  data_files:
+  - split: train_en
+    path: "eng-train.jsonl"
+  - split: train_de
+    path: "deu-train.jsonl"
+  - split: train_fr
+    path: "fra-train.jsonl"
+  - split: train_it
+    path: "ita-train.jsonl"
+  - split: train_po
+    path: "por-train.jsonl"
+  - split: train_sp
+    path: "spa-train.jsonl"
+  - split: validation_en
+    path: "eng-dev.jsonl"
+  - split: validation_de
+    path: "deu-dev.jsonl"
+  - split: validation_fr
+    path: "fra-dev.jsonl"
+  - split: validation_it
+    path: "ita-dev.jsonl"
+  - split: validation_po
+    path: "por-dev.jsonl"
+  - split: validation_sp
+    path: "spa-dev.jsonl"
+  - split: test_en
+    path: "eng-test.jsonl"
+  - split: test_de
+    path: "deu-test.jsonl"
+  - split: test_fr
+    path: "fra-test.jsonl"
+  - split: test_it
+    path: "ita-test.jsonl"
+  - split: test_po
+    path: "por-test.jsonl"
+  - split: test_sp
+    path: "spa-test.jsonl"
+  - split: validation_clean_en
+    path: "eng-dev_clean.jsonl"
+  - split: validation_clean_de
+    path: "deu-dev_clean.jsonl"
+  - split: validation_clean_fr
+    path: "fra-dev_clean.jsonl"
+  - split: validation_clean_it
+    path: "ita-dev_clean.jsonl"
+  - split: validation_clean_po
+    path: "por-dev_clean.jsonl"
+  - split: validation_clean_sp
+    path: "spa-dev_clean.jsonl"
+  - split: test_clean_en
+    path: "eng-test_clean.jsonl"
+  - split: test_clean_de
+    path: "deu-test_clean.jsonl"
+  - split: test_clean_fr
+    path: "fra-test_clean.jsonl"
+  - split: test_cleanit
+    path: "ita-test_clean.jsonl"
+  - split: test_clean_po
+    path: "por-test_clean.jsonl"
+  - split: test_clean_sp
+    path: "spa-test_clean.jsonl"
+  - split: validation_++_en
+    path: "eng-dev_no_allneg.jsonl"
+  - split: validation_++_de
+    path: "deu-dev_no_allneg.jsonl"
+  - split: validation_++_fr
+    path: "fra-dev_no_allneg.jsonl"
+  - split: validation_++_it
+    path: "ita-dev_no_allneg.jsonl"
+  - split: validation_++_po
+    path: "por-dev_no_allneg.jsonl"
+  - split: validation_++_sp
+    path: "spa-dev_no_allneg.jsonl"
+  - split: test_++_en
+    path: "eng-test_no_allneg.jsonl"
+  - split: test_++_de
+    path: "deu-test_no_allneg.jsonl"
+  - split: test_++_fr
+    path: "fra-test_no_allneg.jsonl"
+  - split: test_++_it
+    path: "ita-test_no_allneg.jsonl"
+  - split: test_++_po
+    path: "por-test_no_allneg.jsonl"
+  - split: test_++_sp
+    path: "spa-test_no_allneg.jsonl"
+- config_name: clean
+  data_files:
+  - split: train_en
+    path: "eng-train.jsonl"
+  - split: train_de
+    path: "deu-train.jsonl"
+  - split: train_fr
+    path: "fra-train.jsonl"
+  - split: train_it
+    path: "ita-train.jsonl"
+  - split: train_po
+    path: "por-train.jsonl"
+  - split: train_sp
+    path: "spa-train.jsonl"
+  - split: validation_clean_en
+    path: "eng-dev_clean.jsonl"
+  - split: validation_clean_de
+    path: "deu-dev_clean.jsonl"
+  - split: validation_clean_fr
+    path: "fra-dev_clean.jsonl"
+  - split: validation_clean_it
+    path: "ita-dev_clean.jsonl"
+  - split: validation_clean_po
+    path: "por-dev_clean.jsonl"
+  - split: validation_clean_sp
+    path: "spa-dev_clean.jsonl"
+  - split: test_clean_en
+    path: "eng-test_clean.jsonl"
+  - split: test_clean_de
+    path: "deu-test_clean.jsonl"
+  - split: test_clean_fr
+    path: "fra-test_clean.jsonl"
+  - split: test_cleanit
+    path: "ita-test_clean.jsonl"
+  - split: test_clean_po
+    path: "por-test_clean.jsonl"
+  - split: test_clean_sp
+    path: "spa-test_clean.jsonl"
+- config_name: ++
+  data_files:
+  - split: train_en
+    path: "eng-train.jsonl"
+  - split: train_de
+    path: "deu-train.jsonl"
+  - split: train_fr
+    path: "fra-train.jsonl"
+  - split: train_it
+    path: "ita-train.jsonl"
+  - split: train_po
+    path: "por-train.jsonl"
+  - split: train_sp
+    path: "spa-train.jsonl"
+  - split: validation_++_en
+    path: "eng-dev_no_allneg.jsonl"
+  - split: validation_++_de
+    path: "deu-dev_no_allneg.jsonl"
+  - split: validation_++_fr
+    path: "fra-dev_no_allneg.jsonl"
+  - split: validation_++_it
+    path: "ita-dev_no_allneg.jsonl"
+  - split: validation_++_po
+    path: "por-dev_no_allneg.jsonl"
+  - split: validation_++_sp
+    path: "spa-dev_no_allneg.jsonl"
+  - split: test_++_en
+    path: "eng-test_no_allneg.jsonl"
+  - split: test_++_de
+    path: "deu-test_no_allneg.jsonl"
+  - split: test_++_fr
+    path: "fra-test_no_allneg.jsonl"
+  - split: test_++_it
+    path: "ita-test_no_allneg.jsonl"
+  - split: test_++_po
+    path: "por-test_no_allneg.jsonl"
+  - split: test_++_sp
+    path: "spa-test_no_allneg.jsonl"
+- config_name: en
+  data_files:
+  - split: train
+    path: "eng-train.jsonl"
+  - split: validation
+    path: "eng-dev.jsonl"
+  - split: test
+    path: "eng-test.jsonl"
+- config_name: de
+  data_files:
+  - split: train
+    path: "deu-train.jsonl"
+  - split: validation
+    path: "deu-dev.jsonl"
+  - split: test
+    path: "deu-test.jsonl"
+- config_name: fr
+  data_files:
+  - split: train
+    path: "fra-train.jsonl"
+  - split: validation
+    path: "fra-dev.jsonl"
+  - split: test
+    path: "fra-test.jsonl"
+- config_name: it
+  data_files:
+  - split: train
+    path: "ita-train.jsonl"
+  - split: validation
+    path: "ita-dev.jsonl"
+  - split: test
+    path: "ita-test.jsonl"
+- config_name: po
+  data_files:
+  - split: train
+    path: "por-train.jsonl"
+  - split: validation
+    path: "por-dev.jsonl"
+  - split: test
+    path: "por-test.jsonl"
+- config_name: sp
+  data_files:
+  - split: train
+    path: "spa-train.jsonl"
+  - split: validation
+    path: "spa-dev.jsonl"
+  - split: test
+    path: "spa-test.jsonl"
+- config_name: en_++
+  data_files:
+  - split: train
+    path: "eng-train.jsonl"
+  - split: validation
+    path: "eng-dev_no_allneg.jsonl"
+  - split: test
+    path: "eng-test_no_allneg.jsonl"
+- config_name: de_++
+  data_files:
+  - split: train
+    path: "deu-train.jsonl"
+  - split: validation
+    path: "deu-dev_no_allneg.jsonl"
+  - split: test
+    path: "deu-test_no_allneg.jsonl"
+- config_name: fr_++
+  data_files:
+  - split: train
+    path: "fra-train.jsonl"
+  - split: validation
+    path: "fra-dev_no_allneg.jsonl"
+  - split: test
+    path: "fra-test_no_allneg.jsonl"
+- config_name: it_++
+  data_files:
+  - split: train
+    path: "ita-train.jsonl"
+  - split: validation
+    path: "ita-dev_no_allneg.jsonl"
+  - split: test
+    path: "ita-test_no_allneg.jsonl"
+- config_name: po_++
+  data_files:
+  - split: train
+    path: "por-train.jsonl"
+  - split: validation
+    path: "por-dev_no_allneg.jsonl"
+  - split: test
+    path: "por-test_no_allneg.jsonl"
+- config_name: sp_++
+  data_files:
+  - split: train
+    path: "spa-train.jsonl"
+  - split: validation
+    path: "spa-dev_no_allneg.jsonl"
+  - split: test
+    path: "spa-test_no_allneg.jsonl"
+- config_name: en_clean
+  data_files:
+  - split: train
+    path: "eng-train.jsonl"
+  - split: validation
+    path: "eng-dev_clean.jsonl"
+  - split: test
+    path: "eng-test_clean.jsonl"
+- config_name: de_clean
+  data_files:
+  - split: train
+    path: "deu-train.jsonl"
+  - split: validation
+    path: "deu-dev_clean.jsonl"
+  - split: test
+    path: "deu-test_clean.jsonl"
+- config_name: fr_clean
+  data_files:
+  - split: train
+    path: "fra-train.jsonl"
+  - split: validation
+    path: "fra-dev_clean.jsonl"
+  - split: test
+    path: "fra-test_clean.jsonl"
+- config_name: it_clean
+  data_files:
+  - split: train
+    path: "ita-train.jsonl"
+  - split: validation
+    path: "ita-dev_clean.jsonl"
+  - split: test
+    path: "ita-test_clean.jsonl"
+- config_name: po_clean
+  data_files:
+  - split: train
+    path: "por-train.jsonl"
+  - split: validation
+    path: "por-dev_clean.jsonl"
+  - split: test
+    path: "por-test_clean.jsonl"
+- config_name: sp_clean
+  data_files:
+  - split: train
+    path: "spa-train.jsonl"
+  - split: validation
+    path: "spa-dev_clean.jsonl"
+  - split: test
+    path: "spa-test_clean.jsonl"
+---
+
+## Dataset Description
+
+**mTRECQA** is a translated version of TRECQA. It contains 3,047 questions sampled from Bing query logs. The candidate answer sentences are extracted from Wikipedia and then manually labeled to assess whether they are correct answers.
+
+The dataset has been translated into five European languages: French, German, Italian, Portuguese, and Spanish, as described in this paper: [Datasets for Multilingual Answer Sentence Selection](https://arxiv.org/abs/2406.10172 'Datasets for Multilingual Answer Sentence Selection').
+
+## Splits:
+
+For each language (English, French, German, Italian, Portuguese, and Spanish), we provide:
+
+- **train** split
+- **validation** split
+- **test** split
+
+In addition, the validation and the test splits are available also in the following preprocessed versions:
+
+- **++**: without questions with only negative answer candidates
+- **clean**: without questions with only negative and only positive answer candidates
+
+### How to load them:
+To use these splits, you can use the following snippet of code replacing ``[LANG]`` with a language identifier (en, fr, de, it, po, sp), and ``[VERSION]`` with the version identifier (++, clean)
+
+```
+from datasets import load_dataset
+
+# if you want the whole corpora
+corpora = load_dataset("matteogabburo/mTRECQA")
+
+# if you want the clean test and test sets
+corpora = load_dataset("matteogabburo/mTRECQA", "clean")
+
+# if you want the "no all negatives" validation and test sets
+corpora = load_dataset("matteogabburo/mTRECQA", "++")
+
+"""
+if you want the default splits of a specific language, replace [LANG] with an identifier in: en, fr, de, it, po, sp
+dataset = load_dataset("matteogabburo/mTRECQA", "[LANG]")
+"""
+# example:
+italian_dataset = load_dataset("matteogabburo/mTRECQA", "it")
+
+
+"""
+if you want the processed splits ("clean" and "no all negatives" sets), replace [LANG] with a language identifier and [VERSION] with "++" or "clean"
+dataset = load_dataset("matteogabburo/mTRECQA", "[LANG]_[VERSION]")
+"""
+# example:
+italian_clean_dataset = load_dataset("matteogabburo/mTRECQA", "it_clean")
+
+```
+
+
+## Format:
+Each example has the following format:
+
+```
+{
+  'eid': 42588,
+  'qid': 1003,
+  'cid': 4,
+  'label': 1,
+  'question': 'In welchem Land liegt die heilige Stadt Mekka?',
+  'candidate': 'Der französische Präsident Jacques Chirac hat heute sein Beileid ausgedrückt, wegen des Todes von 250 Pilgern bei einem Brand, der am Dienstag in einem Lager in der Nähe der heiligen Stadt Mekka in Saudi-Arabien ausbrach.'
+}
+```
+
+Where:
+
+- **eid**: is the unique id of the example (question, candidate)
+- **qid**: is the unique id of the question
+- **cid**: is the unique id of the answer candidate
+- **label**: identifies whether the answer candidate ``candidate`` is correct for the ``question`` (1 if correct, 0 otherwise)
+- **question**: the question
+- **candidate**: the answer candidate
+
+
+
+## Citation
+
+If you find this dataset useful, please cite the following paper:
+
+**BibTeX:**
+```
+@misc{gabburo2024datasetsmultilingualanswersentence,
+      title={Datasets for Multilingual Answer Sentence Selection}, 
+      author={Matteo Gabburo and Stefano Campese and Federico Agostini and Alessandro Moschitti},
+      year={2024},
+      eprint={2406.10172},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2406.10172}, 
+}
+```