Update arca23k.py

arca23k.py

@@ -21,6 +21,8 @@ from tqdm.auto import tqdm
 from rich.logging import RichHandler
 from huggingface_hub import hf_hub_download
 
+from ._arca23k import CLASSES, COARSE_TO_FINE
+
 logger = logging.getLogger(__name__)
 logger.addHandler(RichHandler())
 logger.setLevel(logging.INFO)
@@ -29,8 +31,6 @@ VERSION = "0.0.1"
 
 SAMPLE_RATE = 44_100
 
-CLASSES = list(set(LABEL2ID.keys()))
-
 # Cache location
 DEFAULT_XDG_CACHE_HOME = "~/.cache"
 XDG_CACHE_HOME = os.getenv("XDG_CACHE_HOME", DEFAULT_XDG_CACHE_HOME)
@@ -45,4 +45,212 @@ class ARCA23KConfig(datasets.BuilderConfig):
     
     def __init__(self, features, **kwargs):
         super(ARCA23KConfig, self).__init__(version=datasets.Version(VERSION, ""), **kwargs)
-        self.features = features
+        self.features = features
+
+
+class ARCA23K(datasets.GeneratorBasedBuilder):
+
+    BUILDER_CONFIGS = [
+        ARCA23KConfig(
+            features=datasets.Features(
+                {
+                    "file": datasets.Value("string"),
+                    "audio": datasets.Audio(sampling_rate=SAMPLE_RATE),
+                    "sound": datasets.Value("string"), 
+                    "label": datasets.features.ClassLabel(names=CLASSES), 
+                }
+            ),
+            name="v1.0", 
+            description="",
+        ), 
+    ]
+
+    DEFAULT_CONFIG_NAME = "v1.0"
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description="",
+            features=self.config.features,
+            supervised_keys=None,
+            homepage="https://zenodo.org/records/5117901",
+            citation="",
+            task_templates=None,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        for zip_type in ['zip', 'z01', 'z02', 'z03', 'z04']:
+            _filename = f'ARCA23K.audio.{zip_type}'
+            _zip_file_url = f'https://zenodo.org/records/5117901/files/ARCA23K.audio.{zip_type}'
+            _save_path = os.path.join(
+                HF_DATASETS_CACHE, 'confit___arca23k/v1.0', VERSION, _filename
+            )
+            download_file(_zip_file_url, os.path.join(_save_path, _filename))
+            logger.info(f"`{_filename}` is downloaded to {_save_path}")
+
+        main_zip_filename = 'ARCA23K.audio.zip'
+        concat_zip_filename = 'ARCA23K.audio.full.zip'
+        _input_file = os.path.join(HF_DATASETS_CACHE, 'confit___arca23k/v1.0', VERSION, main_zip_filename)
+        _output_file = os.path.join(HF_DATASETS_CACHE, 'confit___arca23k/v1.0', VERSION, concat_zip_filename)
+        
+        if not os.path.exists(_output_file):
+            logger.info(f"Reassemble {_output_file} file")
+            os.system(f"zip -q -F {_input_file} --out {_output_file}")
+        archive_path = dl_manager.extract(_output_file)
+        logger.info(f"`{concat_zip_filename}` is downloaded to {archive_path}")
+
+        metadata_path = dl_manager.download_and_extract("https://zenodo.org/records/5117901/files/ARCA23K-FSD.ground_truth.zip")
+        train_df = pd.read_csv(os.path.join(metadata_path, 'train.csv'))
+        validation_df = pd.read_csv(os.path.join(metadata_path, 'val.csv'))
+        test_df = pd.read_csv(os.path.join(metadata_path, 'test.csv'))
+
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN, gen_kwargs={"archive_path": archive_path, "split": "train", "metadata": train_df}
+            ), 
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION, gen_kwargs={"archive_path": archive_path, "split": "validation", "metadata": validation_df}
+            ), 
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST, gen_kwargs={"archive_path": archive_path, "split": "test", "metadata": test_df}
+            ), 
+        ]
+
+    def _generate_examples(self, archive_path, split=None, metadata=None):
+        extensions = ['.wav']
+        _, _walker = fast_scandir(archive_path, extensions, recursive=True)
+
+        fileid2class = {}
+        for idx, row in metadata.iterrows():
+            fileid2index[row['fname']] = row['label'] # this filename doesn't have suffix
+
+        for guid, audio_path in enumerate(_walker):
+            fileid = Path(audio_path).stem
+            yield guid, {
+                "id": str(guid),
+                "file": audio_path, 
+                "audio": audio_path, 
+                "sound": fileid2index.get(fileid), 
+                "label": fileid2index.get(fileid), 
+            }
+
+
+def fast_scandir(path: str, exts: tp.List[str], recursive: bool = False):
+    # Scan files recursively faster than glob
+    # From github.com/drscotthawley/aeiou/blob/main/aeiou/core.py
+    subfolders, files = [], []
+
+    try:  # hope to avoid 'permission denied' by this try
+        for f in os.scandir(path):
+            try:  # 'hope to avoid too many levels of symbolic links' error
+                if f.is_dir():
+                    subfolders.append(f.path)
+                elif f.is_file():
+                    if os.path.splitext(f.name)[1].lower() in exts:
+                        files.append(f.path)
+            except Exception:
+                pass
+    except Exception:
+        pass
+
+    if recursive:
+        for path in list(subfolders):
+            sf, f = fast_scandir(path, exts, recursive=recursive)
+            subfolders.extend(sf)
+            files.extend(f)  # type: ignore
+
+    return subfolders, files
+
+
+def download_file(
+    source,
+    dest,
+    unpack=False,
+    dest_unpack=None,
+    replace_existing=False,
+    write_permissions=False,
+):
+    """Downloads the file from the given source and saves it in the given
+    destination path.
+     Arguments
+    ---------
+    source : path or url
+        Path of the source file. If the source is an URL, it downloads it from
+        the web.
+    dest : path
+        Destination path.
+    unpack : bool
+        If True, it unpacks the data in the dest folder.
+    dest_unpack: path
+        Path where to store the unpacked dataset
+    replace_existing : bool
+        If True, replaces the existing files.
+    write_permissions: bool
+        When set to True, all the files in the dest_unpack directory will be granted write permissions.
+        This option is active only when unpack=True.
+    """
+    class DownloadProgressBar(tqdm):
+        """DownloadProgressBar class."""
+
+        def update_to(self, b=1, bsize=1, tsize=None):
+            """Needed to support multigpu training."""
+            if tsize is not None:
+                self.total = tsize
+            self.update(b * bsize - self.n)
+
+    # Create the destination directory if it doesn't exist
+    dest_dir = pathlib.Path(dest).resolve().parent
+    dest_dir.mkdir(parents=True, exist_ok=True)
+    if "http" not in source:
+        shutil.copyfile(source, dest)
+
+    elif not os.path.isfile(dest) or (
+        os.path.isfile(dest) and replace_existing
+    ):
+        print(f"Downloading {source} to {dest}")
+        with DownloadProgressBar(
+            unit="B",
+            unit_scale=True,
+            miniters=1,
+            desc=source.split("/")[-1],
+        ) as t:
+            urllib.request.urlretrieve(
+                source, filename=dest, reporthook=t.update_to
+            )
+    else:
+        print(f"{dest} exists. Skipping download")
+
+    # Unpack if necessary
+    if unpack:
+        if dest_unpack is None:
+            dest_unpack = os.path.dirname(dest)
+        print(f"Extracting {dest} to {dest_unpack}")
+        # shutil unpack_archive does not work with tar.gz files
+        if (
+            source.endswith(".tar.gz")
+            or source.endswith(".tgz")
+            or source.endswith(".gz")
+        ):
+            out = dest.replace(".gz", "")
+            with gzip.open(dest, "rb") as f_in:
+                with open(out, "wb") as f_out:
+                    shutil.copyfileobj(f_in, f_out)
+        else:
+            shutil.unpack_archive(dest, dest_unpack)
+        if write_permissions:
+            set_writing_permissions(dest_unpack)
+
+
+def set_writing_permissions(folder_path):
+    """
+    This function sets user writing permissions to all the files in the given folder.
+    Arguments
+    ---------
+    folder_path : folder
+        Folder whose files will be granted write permissions.
+    """
+    for root, dirs, files in os.walk(folder_path):
+        for file_name in files:
+            file_path = os.path.join(root, file_name)
+            # Set writing permissions (mode 0o666) to the file
+            os.chmod(file_path, 0o666)