Add support for streaming (#1)

- Add support for streaming (6675c8bf4182890675f60a2e7a400be9e4b6eddc)

README.md

@@ -145,6 +145,217 @@ configs:
 - nl_hi_2014
 - nl_hi_2015
 - nl_hi_2016
+dataset_info:
+- config_name: eu_ca_2014
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - eu
+        - ca
+  splits:
+  - name: train
+    num_bytes: 15192
+    num_examples: 44
+  download_size: 1666674366
+  dataset_size: 15192
+- config_name: eu_ca_2015
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - eu
+        - ca
+  splits:
+  - name: train
+    num_bytes: 18768
+    num_examples: 52
+  download_size: 1666674366
+  dataset_size: 18768
+- config_name: eu_ca_2016
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - eu
+        - ca
+  splits:
+  - name: train
+    num_bytes: 19506
+    num_examples: 54
+  download_size: 1666674366
+  dataset_size: 19506
+- config_name: nl_en_2014
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - nl
+        - en
+  splits:
+  - name: train
+    num_bytes: 1035545
+    num_examples: 2966
+  download_size: 1666674366
+  dataset_size: 1035545
+- config_name: nl_en_2015
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - nl
+        - en
+  splits:
+  - name: train
+    num_bytes: 1292610
+    num_examples: 3550
+  download_size: 1666674366
+  dataset_size: 1292610
+- config_name: nl_en_2016
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - nl
+        - en
+  splits:
+  - name: train
+    num_bytes: 1434207
+    num_examples: 3852
+  download_size: 1666674366
+  dataset_size: 1434207
+- config_name: nl_hi_2014
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - nl
+        - hi
+  splits:
+  - name: train
+    num_bytes: 214870
+    num_examples: 367
+  download_size: 1666674366
+  dataset_size: 214870
+- config_name: nl_hi_2015
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - nl
+        - hi
+  splits:
+  - name: train
+    num_bytes: 252192
+    num_examples: 421
+  download_size: 1666674366
+  dataset_size: 252192
+- config_name: nl_hi_2016
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - nl
+        - hi
+  splits:
+  - name: train
+    num_bytes: 310922
+    num_examples: 496
+  download_size: 1666674366
+  dataset_size: 310922
+- config_name: de_ja_2014
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - de
+        - ja
+  splits:
+  - name: train
+    num_bytes: 1074403
+    num_examples: 2536
+  download_size: 1666674366
+  dataset_size: 1074403
+- config_name: de_ja_2015
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - de
+        - ja
+  splits:
+  - name: train
+    num_bytes: 1442047
+    num_examples: 3247
+  download_size: 1666674366
+  dataset_size: 1442047
+- config_name: de_ja_2016
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - de
+        - ja
+  splits:
+  - name: train
+    num_bytes: 1630729
+    num_examples: 3590
+  download_size: 1666674366
+  dataset_size: 1630729
+- config_name: fr-ca_hi_2014
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - fr-ca
+        - hi
+  splits:
+  - name: train
+    num_bytes: 74472
+    num_examples: 127
+  download_size: 1666674366
+  dataset_size: 74472
+- config_name: fr-ca_hi_2015
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - fr-ca
+        - hi
+  splits:
+  - name: train
+    num_bytes: 82448
+    num_examples: 141
+  download_size: 1666674366
+  dataset_size: 82448
+- config_name: fr-ca_hi_2016
+  features:
+  - name: translation
+    dtype:
+      translation:
+        languages:
+        - fr-ca
+        - hi
+  splits:
+  - name: train
+    num_bytes: 93425
+    num_examples: 156
+  download_size: 1666674366
+  dataset_size: 93425
 ---
 
 # Dataset Card for Web Inventory of Transcribed & Translated(WIT) Ted Talks
@@ -470,4 +681,4 @@ cc-by-nc-nd-4.0
 
 ### Contributions
 
-Thanks to [@skyprince999](https://github.com/skyprince999) for adding this dataset.
+Thanks to [@skyprince999](https://github.com/skyprince999) for adding this dataset.

ted_talks_iwslt.py

@@ -15,14 +15,13 @@
 """TED TALKS IWSLT: Web Inventory of Transcribed and Translated Ted Talks in 109 languages."""
 
 
-import os
+import io
 import xml.etree.ElementTree as ET
 import zipfile
 from collections import defaultdict
 
 import datasets
 
-
 logger = datasets.logging.get_logger(__name__)
 
 
@@ -63,7 +62,9 @@ _LICENSE = "CC-BY-NC-4.0"
 # TODO: Add link to the official dataset URLs here
 # The HuggingFace dataset library don't host the datasets but only point to the original files
 # This can be an arbitrary nested dict/list of URLs (see below in `_split_generators` method)
-_URL = "https://drive.google.com/u/0/uc?id=1Cz1Un9p8Xn9IpEMMrg2kXSDt0dnjxc4z&export=download"
+_URL = (
+    "https://huggingface.co/datasets/ted_talks_iwslt/resolve/main/data/XML_releases.tgz"
+)
 
 _LANGUAGES = (
     "mr",
@@ -189,7 +190,11 @@ _LANGUAGE_PAIRS = [
 # Year subscripts for the specific folder
 _YEAR = {"2014": "-20140120", "2015": "-20150530", "2016": "-20160408"}
 
-_YEAR_FOLDER = {"2014": "XML_releases/xml-20140120", "2015": "XML_releases/xml-20150616", "2016": "XML_releases/xml"}
+_YEAR_FOLDER = {
+    "2014": "XML_releases/xml-20140120",
+    "2015": "XML_releases/xml-20150616",
+    "2016": "XML_releases/xml",
+}
 
 
 class TedTalksIWSLTConfig(datasets.BuilderConfig):
@@ -209,10 +214,14 @@ class TedTalksIWSLTConfig(datasets.BuilderConfig):
         source, target = language_pair
         assert source in _LANGUAGES, f"Invalid source code in language pair: {source}"
         assert target in _LANGUAGES, f"Invalid target code in language pair: {target}"
-        assert source != target, f"Source::{source} and Target::{target} language pairs cannot be the same!"
+        assert (
+            source != target
+        ), f"Source::{source} and Target::{target} language pairs cannot be the same!"
         assert year in _YEAR.keys()
 
-        description = f"Translation Ted Talks dataset (WIT3) between {source} and {target}"
+        description = (
+            f"Translation Ted Talks dataset (WIT3) between {source} and {target}"
+        )
         super(TedTalksIWSLTConfig, self).__init__(
             name=name,
             description=description,
@@ -232,7 +241,9 @@ class TedTalksIWSLT(datasets.GeneratorBasedBuilder):
     BUILDER_CONFIG_CLASS = TedTalksIWSLTConfig
 
     BUILDER_CONFIGS = [
-        TedTalksIWSLTConfig(language_pair=language_pair, year=year, version=datasets.Version("1.1.0"))
+        TedTalksIWSLTConfig(
+            language_pair=language_pair, year=year, version=datasets.Version("1.1.0")
+        )
         for language_pair in _LANGUAGE_PAIRS
         for year in _YEAR.keys()
     ]
@@ -240,7 +251,9 @@ class TedTalksIWSLT(datasets.GeneratorBasedBuilder):
     def _info(self):
         features = datasets.Features(
             {
-                "translation": datasets.features.Translation(languages=self.config.language_pair),
+                "translation": datasets.features.Translation(
+                    languages=self.config.language_pair
+                ),
             },
         )
 
@@ -263,88 +276,79 @@ class TedTalksIWSLT(datasets.GeneratorBasedBuilder):
 
     def _split_generators(self, dl_manager):
         """Returns SplitGenerators."""
-        # TODO: This method is tasked with downloading/extracting the data and defining the splits depending on the configuration
-        # If several configurations are possible (listed in BUILDER_CONFIGS), the configuration selected by the user is in self.config.name
-
-        # dl_manager is a datasets.download.DownloadManager that can be used to download and extract URLs
-        # It can accept any type or nested list/dict and will give back the same structure with the url replaced with path to local files.
-        # By default the archives will be extracted and a path to a cached folder where they are extracted is returned instead of the archive
-        my_urls = _URL
-        language_pair = self.config.language_pair
-        year = self.config.year
-
-        data_dir = dl_manager.download_and_extract(my_urls)
-
-        zip_file_pair0 = os.path.join(data_dir, _YEAR_FOLDER[year] + "/ted_" + language_pair[0] + _YEAR[year] + ".zip")
-        zip_file_pair1 = os.path.join(data_dir, _YEAR_FOLDER[year] + "/ted_" + language_pair[1] + _YEAR[year] + ".zip")
+        data_dir = dl_manager.download(_URL)
 
         return [
             datasets.SplitGenerator(
                 name=datasets.Split.TRAIN,
-                # These kwargs will be passed to _generate_examples
                 gen_kwargs={
-                    "filepath": [zip_file_pair0, zip_file_pair1],
-                    "split": "train",
+                    "files": dl_manager.iter_archive(data_dir),
                 },
             ),
         ]
 
-    def _generate_examples(self, filepath, split):
+    def _generate_examples(self, files):
         """Yields examples."""
-        # TODO: This method will receive as arguments the `gen_kwargs` defined in the previous `_split_generators` method.
-        # It is in charge of opening the given file and yielding (key, example) tuples from the dataset
-        # The key is not important, it's more here for legacy reason (legacy from tfds)
-        source = filepath[0]
-        target = filepath[1]
-
-        language_pair = self.config.name.split("_")
-
-        def et_to_dict(tree):
-            """This is used to convert the xml to a list of dicts"""
-
-            dct = {tree.tag: {} if tree.attrib else None}
-            children = list(tree)
-            if children:
-                dd = defaultdict(list)
-                for dc in map(et_to_dict, children):
-                    for k, v in dc.items():
-                        dd[k].append(v)
-                dct = {tree.tag: dd}
-            if tree.attrib:
-                dct[tree.tag].update((k, v) for k, v in tree.attrib.items())
-            if tree.text:
-                text = tree.text.strip()
-                if children or tree.attrib:
-                    if text:
-                        dct[tree.tag]["text"] = text
-                else:
-                    dct[tree.tag] = text
-            return dct
-
-        if os.path.exists(source) and os.path.exists(target):
-
-            with zipfile.ZipFile(source) as zf_source:
-                with zipfile.ZipFile(target) as zf_target:
-                    try:
-                        tree_source = ET.parse(zf_source.open(source.split("/")[-1][:-3] + "xml"))
-                        root_source = tree_source.getroot()
-                        source_talks = et_to_dict(root_source).get("xml").get("file")
-
-                        tree_target = ET.parse(zf_target.open(target.split("/")[-1][:-3] + "xml"))
-                        root_target = tree_target.getroot()
-                        target_talks = et_to_dict(root_target).get("xml").get("file")
-
-                        source_ids = [talk.get("head")[0].get("talkid") for talk in source_talks]
-                        target_ids = [talk.get("head")[0].get("talkid") for talk in target_talks]
-                    except Exception as pe:
-                        logger.warning(f"ERROR: {pe}")
-                        logger.warning(
-                            f"This likely means that you have a malformed XML file!\nEither {source} or {target}\n"
-                        )
-                        source_ids = list()
-                        target_ids = list()
-        else:
-            logger.warning(f"File doesn't exist {source} or {target}")
+
+        def parse_zip_file(path, file):
+            def et_to_dict(tree):
+                """This is used to convert the xml to a list of dicts"""
+
+                dct = {tree.tag: {} if tree.attrib else None}
+                children = list(tree)
+                if children:
+                    dd = defaultdict(list)
+                    for dc in map(et_to_dict, children):
+                        for k, v in dc.items():
+                            dd[k].append(v)
+                    dct = {tree.tag: dd}
+                if tree.attrib:
+                    dct[tree.tag].update((k, v) for k, v in tree.attrib.items())
+                if tree.text:
+                    text = tree.text.strip()
+                    if children or tree.attrib:
+                        if text:
+                            dct[tree.tag]["text"] = text
+                    else:
+                        dct[tree.tag] = text
+                return dct
+
+            with zipfile.ZipFile(io.BytesIO(file)) as zf:
+                try:
+                    tree = ET.parse(zf.open(path.split("/")[-1][:-3] + "xml"))
+                    root = tree.getroot()
+                    talks = et_to_dict(root).get("xml").get("file")
+                    ids = [talk.get("head")[0].get("talkid") for talk in talks]
+                except Exception as pe:
+                    logger.warning(f"ERROR: {pe}")
+                    logger.warning(
+                        "This likely means that you have a malformed XML file!"
+                    )
+                    ids = []
+            return talks, ids
+
+        language_pair = self.config.language_pair
+        year = self.config.year
+
+        source_file_path = (
+            _YEAR_FOLDER[year] + "/ted_" + language_pair[0] + _YEAR[year] + ".zip"
+        )
+        target_file_path = (
+            _YEAR_FOLDER[year] + "/ted_" + language_pair[1] + _YEAR[year] + ".zip"
+        )
+
+        source_talks, source_ids = None, None
+        target_talks, target_ids = None, None
+        for path, file in files:
+            if source_ids is not None and target_ids is not None:
+                break
+
+            if source_ids is None and path.endswith(source_file_path):
+                source_talks, source_ids = parse_zip_file(path, file.read())
+            elif target_ids is None and path.endswith(target_file_path):
+                target_talks, target_ids = parse_zip_file(path, file.read())
+
+        if source_ids is None or target_ids is None:
             source_ids = list()
             target_ids = list()
 
@@ -353,8 +357,18 @@ class TedTalksIWSLT(datasets.GeneratorBasedBuilder):
         translation = list()
 
         for talkid in comm_talkids:
-            source = list(filter(lambda talk: talk.get("head")[0].get("talkid") == talkid, source_talks))
-            target = list(filter(lambda talk: talk.get("head")[0].get("talkid") == talkid, target_talks))
+            source = list(
+                filter(
+                    lambda talk: talk.get("head")[0].get("talkid") == talkid,
+                    source_talks,
+                )
+            )
+            target = list(
+                filter(
+                    lambda talk: talk.get("head")[0].get("talkid") == talkid,
+                    target_talks,
+                )
+            )
 
             if len(source) == 0 or len(target) == 0:
                 pass
@@ -362,33 +376,57 @@ class TedTalksIWSLT(datasets.GeneratorBasedBuilder):
                 source = source[0]
                 target = target[0]
 
-            if source.get("head")[0].get("description") and target.get("head")[0].get("description"):
-                if source.get("head")[0].get("description")[0] and target.get("head")[0].get("description")[0]:
+            if source.get("head")[0].get("description") and target.get("head")[0].get(
+                "description"
+            ):
+                if (
+                    source.get("head")[0].get("description")[0]
+                    and target.get("head")[0].get("description")[0]
+                ):
                     temp_dict = dict()
                     temp_dict["id"] = source.get("head")[0].get("talkid")[0] + "_1"
                     temp_dict[language_pair[0]] = (
-                        source.get("head")[0].get("description")[0].replace("TED Talk Subtitles and Transcript: ", "")
+                        source.get("head")[0]
+                        .get("description")[0]
+                        .replace("TED Talk Subtitles and Transcript: ", "")
                     )
                     temp_dict[language_pair[1]] = (
-                        target.get("head")[0].get("description")[0].replace("TED Talk Subtitles and Transcript: ", "")
+                        target.get("head")[0]
+                        .get("description")[0]
+                        .replace("TED Talk Subtitles and Transcript: ", "")
                     )
                     translation.append(temp_dict)
 
-            if source.get("head")[0].get("title") and target.get("head")[0].get("title"):
-                if source.get("head")[0].get("title")[0] and target.get("head")[0].get("title")[0]:
+            if source.get("head")[0].get("title") and target.get("head")[0].get(
+                "title"
+            ):
+                if (
+                    source.get("head")[0].get("title")[0]
+                    and target.get("head")[0].get("title")[0]
+                ):
                     temp_dict = dict()
                     temp_dict["id"] = source.get("head")[0].get("talkid")[0] + "_2"
                     temp_dict[language_pair[0]] = source.get("head")[0].get("title")[0]
                     temp_dict[language_pair[1]] = target.get("head")[0].get("title")[0]
                     translation.append(temp_dict)
 
-            if source.get("head")[0].get("seekvideo") and target.get("head")[0].get("seekvideo"):
-                source_transc = source.get("head")[0].get("transcription")[0].get("seekvideo")
-                target_transc = target.get("head")[0].get("transcription")[0].get("seekvideo")
+            if source.get("head")[0].get("seekvideo") and target.get("head")[0].get(
+                "seekvideo"
+            ):
+                source_transc = (
+                    source.get("head")[0].get("transcription")[0].get("seekvideo")
+                )
+                target_transc = (
+                    target.get("head")[0].get("transcription")[0].get("seekvideo")
+                )
 
                 transc = zip(source_transc, target_transc)
                 transcriptions = [
-                    {"id": s.get("id"), language_pair[0]: s.get("text"), language_pair[1]: t.get("text")}
+                    {
+                        "id": s.get("id"),
+                        language_pair[0]: s.get("text"),
+                        language_pair[1]: t.get("text"),
+                    }
                     for s, t in transc
                 ]
                 translation.extend(transcriptions)