fix ccmatrix loading

nllb.py

@@ -26,7 +26,7 @@ import typing as tp
 _CITATION = (
     "@article{team2022NoLL,"
     "title={No Language Left Behind: Scaling Human-Centered Machine Translation},"
-    "author={Nllb team and Marta Ruiz Costa-juss{\`a} and James Cross and Onur Celebi and Maha Elbayad and Kenneth Heafield and Kevin Heffernan and Elahe Kalbassi and Janice Lam and Daniel Licht and Jean Maillard and Anna Sun and Skyler Wang and Guillaume Wenzek and Alison Youngblood and Bapi Akula and Lo{\"i}c Barrault and Gabriel Mejia Gonzalez and Prangthip Hansanti and John Hoffman and Semarley Jarrett and Kaushik Ram Sadagopan and Dirk Rowe and Shannon L. Spruit and C. Tran and Pierre Andrews and Necip Fazil Ayan and Shruti Bhosale and Sergey Edunov and Angela Fan and Cynthia Gao and Vedanuj Goswami and Francisco Guzm'an and Philipp Koehn and Alexandre Mourachko and Christophe Ropers and Safiyyah Saleem and Holger Schwenk and Jeff Wang},"
+    r"author={Nllb team and Marta Ruiz Costa-juss{\`a} and James Cross and Onur Celebi and Maha Elbayad and Kenneth Heafield and Kevin Heffernan and Elahe Kalbassi and Janice Lam and Daniel Licht and Jean Maillard and Anna Sun and Skyler Wang and Guillaume Wenzek and Alison Youngblood and Bapi Akula and Lo{\"i}c Barrault and Gabriel Mejia Gonzalez and Prangthip Hansanti and John Hoffman and Semarley Jarrett and Kaushik Ram Sadagopan and Dirk Rowe and Shannon L. Spruit and C. Tran and Pierre Andrews and Necip Fazil Ayan and Shruti Bhosale and Sergey Edunov and Angela Fan and Cynthia Gao and Vedanuj Goswami and Francisco Guzm'an and Philipp Koehn and Alexandre Mourachko and Christophe Ropers and Safiyyah Saleem and Holger Schwenk and Jeff Wang},"
     "journal={ArXiv},"
     "year={2022},"
     "volume={abs/2207.04672}"
@@ -41,61 +41,55 @@ _HOMEPAGE = ""  # TODO
 _LICENSE = "https://opendatacommons.org/licenses/by/1-0/"
 
 from .nllb_lang_pairs import LANG_PAIRS as _LANGUAGE_PAIRS
-from .ccmatrix_lang_pairs import LANG_PAIRS as _CCMATRIX_LANGUAGE_PAIRS
-
-_URL_BASE = "https://storage.googleapis.com/allennlp-data-bucket/nllb/"
-
-_URLs = {
-    f"{src_lg}-{trg_lg}": f"{_URL_BASE}{src_lg}-{trg_lg}.gz"
-    for src_lg, trg_lg in _LANGUAGE_PAIRS
-}
+from .ccmatrix_lang_pairs import PAIRS as CCMATRIX_PAIRS
+from .ccmatrix_lang_pairs import MAPPING as CCMATRIX_MAPPING
 
+_ALLENAI_URL = "https://storage.googleapis.com/allennlp-data-bucket/nllb/"
 _STATMT_URL = "http://data.statmt.org/cc-matrix/"
-_URLs.update(
-    {
-        f"{src_lg}-{trg_lg}": f"{_STATMT_URL}{src_lg}-{trg_lg}.bitextf.tsv.gz"
-        for src_lg, trg_lg in _CCMATRIX_LANGUAGE_PAIRS
-    }
-)
 
 
 class NLLBTaskConfig(datasets.BuilderConfig):
     """BuilderConfig for No Language Left Behind Dataset."""
 
-    def __init__(self, src_lg, tgt_lg, source, **kwargs):
+    def __init__(self, src_lg, tgt_lg, url, **kwargs):
         super(NLLBTaskConfig, self).__init__(**kwargs)
         self.src_lg = src_lg
         self.tgt_lg = tgt_lg
-        url = _URLs.get(f"{src_lg}-{tgt_lg}", "")
-        self.source = source
-
+        self.url = url
+        self.source = "statmt" if url.startswith(_STATMT_URL) else "allenai"
 
 def _builder_configs() -> tp.List[NLLBTaskConfig]:
-    configs = []
-    for (src_lg, tgt_lg) in _LANGUAGE_PAIRS:
-        configs.append(
-            NLLBTaskConfig(
-                name=f"{src_lg}-{tgt_lg}",
-                version=datasets.Version("1.0.0"),
-                description=f"No Language Left Behind (NLLB): {src_lg} - {tgt_lg}",
-                src_lg=src_lg,
-                tgt_lg=tgt_lg,
-                source="allenai",
-            )
+    """
+    Note we always return data from AllenAI if possible because CC-Matrix data
+    is older, and most language pairs have been improved between the two versions.
+    """
+    configs = {}
+
+    for (src, tgt) in CCMATRIX_PAIRS:
+        src_lg = CCMATRIX_MAPPING[src]
+        tgt_lg = CCMATRIX_MAPPING[tgt]
+        if not src_lg or not tgt_lg:
+            continue
+        configs[(src_lg, tgt_lg)] = NLLBTaskConfig(
+            name=f"{src_lg}-{tgt_lg}",
+            version=datasets.Version("1.0.0"),
+            description=f"No Language Left Behind (NLLB): {src_lg} - {tgt_lg}",
+            src_lg=src_lg,
+            tgt_lg=tgt_lg,
+            # Use CCMatrix language code to fetch from statmt
+            url = f"{_STATMT_URL}{src}-{tgt}.bitextf.tsv.gz"
         )
 
-    for (src_lg, tgt_lg) in _CCMATRIX_LANGUAGE_PAIRS:
-        configs.append(
-            NLLBTaskConfig(
-                name=f"{src_lg}-{tgt_lg}",
-                version=datasets.Version("1.0.0"),
-                description=f"No Language Left Behind (NLLB): {src_lg} - {tgt_lg}",
-                src_lg=src_lg,
-                tgt_lg=tgt_lg,
-                source="mtstats",
-            )
+    for (src_lg, tgt_lg) in _LANGUAGE_PAIRS:
+        configs[(src_lg, tgt_lg)] = NLLBTaskConfig(
+            name=f"{src_lg}-{tgt_lg}",
+            version=datasets.Version("1.0.0"),
+            description=f"No Language Left Behind (NLLB): {src_lg} - {tgt_lg}",
+            src_lg=src_lg,
+            tgt_lg=tgt_lg,
+            url = f"{_ALLENAI_URL}{src_lg}-{tgt_lg}.gz"
         )
-    return configs
+    return list(configs.values())
 
 
 class NLLB(datasets.GeneratorBasedBuilder):
@@ -120,7 +114,7 @@ class NLLB(datasets.GeneratorBasedBuilder):
                 "target_sentence_url": datasets.Value("string"),
             }
         )
-        if self.config.source == "mtstats":
+        if self.config.source == "statmt":
             # MT stats didn't published all the metadata
             features = datasets.Features(
                 {
@@ -141,18 +135,16 @@ class NLLB(datasets.GeneratorBasedBuilder):
         )
 
     def _split_generators(self, dl_manager):
-        """Returns SplitGenerators."""
-        pair = f"{self.config.src_lg}-{self.config.tgt_lg}"  # string identifier for language pair
-        url = _URLs[pair]  # url for download of pair-specific file
-        data_file = dl_manager.download_and_extract(
-            url
-        )  # extract downloaded data and store path in data_file
+        """Returns one training generator. NLLB200 is meant for training.
 
+        If you're interested in evaluation look at https://huggingface.co/datasets/facebook/flores
+        """
+        local_file = dl_manager.download_and_extract(self.config.url)
         return [
             datasets.SplitGenerator(
                 name=datasets.Split.TRAIN,
                 gen_kwargs={
-                    "filepath": data_file,
+                    "filepath": local_file,
                     "source_lg": self.config.src_lg,
                     "target_lg": self.config.tgt_lg,
                 },
@@ -160,7 +152,7 @@ class NLLB(datasets.GeneratorBasedBuilder):
         ]
 
     def _generate_examples(self, filepath, source_lg, target_lg):
-        if self.config.source == "mtstats":
+        if self.config.source == "statmt":
             # MT stats didn't published all the metadata
             return self._generate_minimal_examples(filepath, source_lg, target_lg)
 
@@ -173,10 +165,11 @@ class NLLB(datasets.GeneratorBasedBuilder):
                 try:
                     datarow = example.split("\t")
                     row = {}
+                    # create translation json
                     row["translation"] = {
                         source_lg: datarow[0],
                         target_lg: datarow[1],
-                    }  # create translation json
+                    }
                     row["laser_score"] = float(datarow[2])
                     row["source_sentence_lid"] = float(datarow[3])
                     row["target_sentence_lid"] = float(datarow[4])
@@ -184,9 +177,8 @@ class NLLB(datasets.GeneratorBasedBuilder):
                     row["source_sentence_url"] = datarow[6]
                     row["target_sentence_source"] = datarow[7]
                     row["target_sentence_url"] = datarow[8]
-                    row = {
-                        k: None if not v else v for k, v in row.items()
-                    }  # replace empty values
+                    # replace empty values
+                    row = {k: None if not v else v for k, v in row.items()}
                 except:
                     print(datarow)
                     raise