feat(pulled): added support for pulled dataset config

pale.py

@@ -1,6 +1,7 @@
-from pandas import read_csv
+import os
+from pandas import read_csv, NA
 
-from datasets import GeneratorBasedBuilder, Value, Version, BuilderConfig, Features, DatasetInfo, SplitGenerator, Split
+from datasets import GeneratorBasedBuilder, Value, Version, BuilderConfig, Features, DatasetInfo, SplitGenerator, Split, Audio
 
 _DESCRIPTION = '''
 This dataset contains transcribed sounds emitted by characters of the League of Legends game.
@@ -15,9 +16,12 @@ _LICENSE = 'Apache License Version 2.0'
 _URLS = {
     'full': 'https://huggingface.co/datasets/zeio/pale/resolve/main/pale.tsv',
     'quotes': 'https://huggingface.co/datasets/zeio/pale/resolve/main/quotes.tsv',
-    'annotated': 'https://huggingface.co/datasets/zeio/pale/resolve/main/annotated.tsv'
+    'annotated': 'https://huggingface.co/datasets/zeio/pale/resolve/main/annotated.tsv',
+    'pulled': 'https://huggingface.co/datasets/zeio/pale/resolve/main/pulled.tsv'
 }
 
+_SOUND_URL = 'https://huggingface.co/datasets/zeio/pale/resolve/main/sound.tar.xz'
+
 
 class Pale(GeneratorBasedBuilder):
 
@@ -26,7 +30,8 @@ class Pale(GeneratorBasedBuilder):
     BUILDER_CONFIGS = [
         BuilderConfig(name = 'quotes', version = VERSION, description = 'Truncated version of the corpus, which does\'t contain sound effects'),
         BuilderConfig(name = 'annotated', version = VERSION, description = 'An extended version of the full configuration with a couple of additional columns with labels'),
-        BuilderConfig(name = 'vanilla', version = VERSION, description = 'All data pulled from the website without significant modifications apart from the web page structure parsing')
+        BuilderConfig(name = 'vanilla', version = VERSION, description = 'All data pulled from the website without significant modifications apart from the web page structure parsing'),
+        BuilderConfig(name = 'pulled', version = VERSION, description = 'Same as vanilla, but sound files have been pulled from the website, and "source" command is replaced with "sound" column')
     ]
 
     DEFAULT_CONFIG_NAME = 'quotes'
@@ -56,6 +61,16 @@ class Pale(GeneratorBasedBuilder):
                 'text': Value('string'),
                 'champion': Value('string')
             })
+        elif self.config.name == 'pulled':
+            features = Features({
+                'header': Value('string'),
+                'subheader': Value('string'),
+                'text': Value('string'),
+                'sound': Audio(sampling_rate = 44_100),
+                'champion': Value('string')
+            })
+        else:
+            raise ValueError(f'Unknown config: {self.config.name}')
 
         return DatasetInfo(
             description=_DESCRIPTION,
@@ -73,11 +88,28 @@ class Pale(GeneratorBasedBuilder):
             SplitGenerator(
                 name = Split.TRAIN,
                 gen_kwargs = {
-                    "path": dl_manager.download_and_extract(url)
+                    "path": dl_manager.download_and_extract(url),
+                    'sound': dl_manager.download_and_extract(_SOUND_URL) if name == 'pulled' else None
                 }
             )
         ]
 
-    def _generate_examples(self, path: str):
+    def _generate_examples(self, path: str, sound: str):
         for i, row in read_csv(path, sep = '\t').iterrows():
-            yield i, dict(row)
+            if sound is None:
+                yield i, dict(row)
+            else:
+                data = dict(row)
+
+                folder = data['folder']
+                filename = data['filename']
+
+                if folder == folder and filename == filename:  # if folder and filename are not nan
+                    data['sound'] = os.path.join(sound, folder, f'{filename}.ogg')
+                else:
+                    data['sound'] = NA
+
+                data.pop('folder')
+                data.pop('filename')
+
+                yield i, data