Update README.md

README.md

@@ -1,21 +1,67 @@
 # Dataset Summary
-This repository provides the mMARCO dataset.
-This dataset was created by translating the MS MARCO Passage Ranking dataset into 8 different languages.
+
+**mMARCO** is a multilingual version of the [MS MARCO passage ranking dataset](https://microsoft.github.io/msmarco/).
+For more information, checkout our papers:
+  * [**mMARCO: A Multilingual Version of the MS MARCO Passage Ranking Dataset**](https://arxiv.org/abs/2108.13897)
+  * [**A cost-benefit analysis of cross-lingual transfer methods**](https://arxiv.org/abs/2105.06813)
+
+
+There are two translated versions of mMARCO.
+
+  * **v1**
+  In v1 version, we use MarianNMT an open-source neural machine translation framework [made available](https://huggingface.co/Helsinki-NLP) by the Language Technology Research Group at the University of Helsinki for more than a thousand language pairs for translation. This version comprises 8 languages: Chinese, French, German, Indonesian, Italian, Portuguese, Russian and Spanish. In the paper, we refer to these models as "Helsinki".
+
+  * **v2 (Recommended)**
+  In v2 version, we use Google Translate to translate the dataset. In this commercial translation version, besides the 8 languages from v1, we add other 5 languages: Japanese, Dutch, Vietnamese, Hindi and Arabic.
+
+
+### Supported languages
+
+| Language name | Language code | v1 | v2 |
+|---------------|---------------| ✓  | ✓  |
+| English		| english		| ✓  | ✓  |
+| Chinese		| chinese		| ✓  | ✓  |
+| French		| french		| ✓  | ✓  |
+| German		| german		| ✓  | ✓  |
+| Indonesian	| indonesian	| ✓  | ✓  |
+| Italian		| italian		| ✓  | ✓  |
+| Portuguese	| portuguese	| ✓  | ✓  |
+| Russian		| russian		| ✓  | ✓  |
+| Spanish		| spanish		| ✓  | ✓  |
+| Arabic        | arabic        |    | ✓  |
+| Dutch         | dutch         |    | ✓  |
+| Hindi         | hindi         |    | ✓  |
+| Japanese      | japanese      |    | ✓  |
+| Vietnamese    | vietnamese    |    | ✓  |
+
 
 # Dataset Structure
-You can load mMARCO dataset by choosing a specific language.
-For each language, there are four splits. The first split contains all the passages from the dataset. The last two splits are the training and development queries.
-An example of 'collection' from portuguese looks as follows.
+
+You can load mMARCO dataset by choosing a specific language. We include training triples (query, positive and negative example), the translated collections of documents and queries.
+
+
+#### Training triples
+
 ```
-{
-    "doc_id": "0",
-    "document": "A presença da comunicação em meio às mentes científicas era igualmente importante para o sucesso do Projeto Manhattan como o intelecto científico era. A única nuvem pendurada sobre a impressionante conquista dos pesquisadores e engenheiros atômicos é o que seu sucesso realmente significava; centenas de milhares de vidas inocentes destruídas."
-}
+>>> dataset = load_dataset('mmarco', 'english')
+>>> dataset['train'][1]
+{'query': 'what fruit is native to australia', 'positive': 'Passiflora herbertiana. A rare passion fruit native to Australia. Fruits are green-skinned, white fleshed, with an unknown edible rating. Some sources list the fruit as edible, sweet and tasty, while others list the fruits as being bitter and inedible.assiflora herbertiana. A rare passion fruit native to Australia. Fruits are green-skinned, white fleshed, with an unknown edible rating. Some sources list the fruit as edible, sweet and tasty, while others list the fruits as being bitter and inedible.', 'negative': 'The kola nut is the fruit of the kola tree, a genus (Cola) of trees that are native to the tropical rainforests of Africa.'}
+```
+
+#### Queries
+
+```
+>>> dataset = load_dataset('mmarco', 'queries-spanish')
+>>> dataset['train'][1]
+{'id': 634306, 'text': '¿Qué significa Chattel en el historial de crédito'}
 ```
-# Load Dataset
-An example to load the dataset:
+
+#### Collection
+
 ```
-dataset = load_dataset('unicamp-dl/mmarco', language='portuguese')
+>>> dataset = load_dataset('mmarco', 'collection-portuguese')
+>>> dataset['collection'][100]
+{'id': 100, 'text': 'Antonín Dvorák (1841-1904) Antonin Dvorak era filho de açougueiro, mas ele não seguiu o negócio de seu pai. Enquanto ajudava seu pai a meio tempo, estudou música e se formou na Escola de Órgãos de Praga em 1859.'}
 ```
 
 

mmarco.py

@@ -117,15 +117,20 @@ _BASE_URLS = {
 }
 
 LANGUAGES = [
+    "arabic",
     "chinese",
+    "dutch",
     "english",
     "french",
     "german",
+    "hindi",
     "indonesian",
     "italian",
+    "japanese",
     "portuguese",
     "russian",
     "spanish",
+    "vietnamese",
 ]