First commit - Todos in Readme before release

README.md

@@ -0,0 +1,265 @@
+---
+license: cc-by-4.0
+task_categories:
+- audio-classification
+pretty_name: >-
+  Enriched DCASE 2023 Challenge Task 2 Dataset
+size_categories:
+- 1K<n<10K
+tags:
+- anomaly detection 
+- anomalous sound detection 
+- acoustic condition monitoring 
+- sound machine fault diagnosis 
+- machine learning 
+- unsupervised learning 
+- acoustic scene classification 
+- acoustic event detection 
+- acoustic signal processing 
+- audio domain shift 
+- domain generalization
+---
+
+
+# Dataset Card for the Enriched "DCASE 2023 Challenge Task 2 Dataset".
+
+[//]: # (todo)
+
+## Table of contents
+
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Explore the data with Spotlight](#explore-the-data-with-spotlight)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Supported Tasks and Leaderboards (original: Overview of the task)](#supported-tasks-and-leaderboards-original-overview-of-the-task)
+  - [Source Data](#source-data)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Baseline system](#baseline-system)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information - Condition of use](#licensing-information---condition-of-use)
+  - [Citation Information (original)](#citation-information-original)
+
+## Dataset Description
+
+- **Homepage:** [Renumics Homepage](https://renumics.com/)
+- **Original Dataset Upload** [ZENODO: DCASE 2023 Challenge Task 2 Development Dataset](https://zenodo.org/record/7687464#.Y_9VtdLMLmE)
+- **Paper** [MIMII DG](https://arxiv.org/abs/2205.13879)
+- **Paper** [ToyADMOS2](https://arxiv.org/abs/2106.02369)
+
+### Dataset Summary
+
+[//]: # (todo)
+
+[//]: # (todo: verantwortlichkeit)
+
+### Explore the data with Spotlight
+
+Install Spotlight via [pip](https://packaging.python.org/en/latest/key_projects/#pip)
+```bash
+pip install renumics-spotlight
+```
+
+and simply run the following codeblock:
+```jupyterpython
+from datasets import load_dataset
+from renumics import spotlight
+
+ds = load_dataset("renumics/dcase23-task2-enriched", "dev")
+df = ds.to_pandas()
+spotlight.show(df, dtype={'path': spotlight.Audio})
+```
+
+advanced view:
+```jupyterpython
+from datasets import load_dataset, load_dataset_builder
+from renumics import spotlight
+
+ds = load_dataset("renumics/dcase23-task2-enriched", "dev", split="train", streaming=False)
+db = load_dataset_builder("renumics/dcase23-task2-enriched", "dev")
+
+df = db.config.to_spotlight(ds)
+spotlight.show(df, dtype={'audio': spotlight.Audio, 'baseline-embeddings': spotlight.Embedding}, layout=db.config.get_layout())
+```
+
+[//]: # (todo: add embeddings column)
+
+## Dataset Structure
+
+### Data Instances
+
+For each instance, there is a Audio for the audio, a string for the path, an integer for the section, a string for the d1p (parameter), a string for the d1v (value),
+a ClassLabel for the label and a ClassLabel for the class.
+
+[//]: # (todo)
+```
+{'audio': {'array': array([ 0.        ,  0.00024414, -0.00024414, ..., -0.00024414,
+         0.        ,  0.        ], dtype=float32),
+ 'path': 'train/fan_section_01_source_train_normal_0592_f-n_A.wav',
+ 'sampling_rate': 16000
+}
+ 'path': 'train/fan_section_01_source_train_normal_0592_f-n_A.wav'
+ 'section': 1
+ 'd1p': 'f-n'
+ 'd1v': 'A'
+ 'd2p': ''
+ 'd2v': ''
+ 'd3p': ''
+ 'd3v': ''
+ 'label': 0 (normal)
+ 'class': 0 (fan)
+}
+```
+
+The length of each audio file is 10 seconds.
+
+### Data Fields
+
+[//]: # (todo)
+
+- `audio`:
+- `path`: a string representing the path of the audio file inside the _tar.gz._-archive.
+- `section`: an integer
+- `d*p`:
+- `d*v`:
+- `class`:
+- `label`: an integer whose value may be either _0_, indicating that the audio sample is _normal_, _1_, indicating that the audio sample contains an _anomaly_.
+
+[//]: # (todo)
+
+### Data Splits
+
+The development dataset has 2 splits: _train_ and _test_.
+
+| Dataset Split | Number of Instances in Split |
+| ------------- |----------------------------- |
+| Train         | TODO                         |
+| Test          | TODO                         |
+
+The information for the evaluation dataset will follow after release.
+
+## Dataset Creation
+
+### Curation Rationale
+
+This dataset is the "development dataset" for the [DCASE 2023 Challenge Task 2 "First-Shot Unsupervised Anomalous Sound Detection for Machine Condition Monitoring"](https://dcase.community/challenge2023/task-unsupervised-anomalous-sound-detection-for-machine-condition-monitoring).
+
+The data consists of the normal/anomalous operating sounds of seven types of real/toy machines. Each recording is a single-channel 10-second audio that includes both a machine's operating sound and environmental noise. The following seven types of real/toy machines are used in this task:
+
+- ToyCar
+- ToyTrain
+- Fan
+- Gearbox
+- Bearing
+- Slide rail
+- Valve
+
+### Supported Tasks and Leaderboards (original: Overview of the task)
+
+Anomalous sound detection (ASD) is the task of identifying whether the sound emitted from a target machine is normal or anomalous. Automatic detection of mechanical failure is an essential technology in the fourth industrial revolution, which involves artificial-intelligence-based factory automation. Prompt detection of machine anomalies by observing sounds is useful for monitoring the condition of machines. 
+
+This task is the follow-up from DCASE 2020 Task 2 to DCASE 2022 Task 2. The task this year is to develop an ASD system that meets the following four requirements.
+ 
+**1. Train a model using only normal sound (unsupervised learning scenario)**
+
+Because anomalies rarely occur and are highly diverse in real-world factories, it can be difficult to collect exhaustive patterns of anomalous sounds. Therefore, the system must detect unknown types of anomalous sounds that are not provided in the training data. This is the same requirement as in the previous tasks.
+
+**2. Detect anomalies regardless of domain shifts (domain generalization task)** 
+
+In real-world cases, the operational states of a machine or the environmental noise can change to cause domain shifts. Domain-generalization techniques can be useful for handling domain shifts that occur frequently or are hard-to-notice. In this task, the system is required to use domain-generalization techniques for handling these domain shifts. This requirement is the same as in DCASE 2022 Task 2.
+
+**3. Train a model for a completely new machine type**
+
+For a completely new machine type, hyperparameters of the trained model cannot be tuned. Therefore, the system should have the ability to train models without additional hyperparameter tuning.
+
+**4. Train a model using only one machine from its machine type**
+
+While sounds from multiple machines of the same machine type can be used to enhance detection performance, it is often the case that sound data from only one machine are available for a machine type. In such a case, the system should be able to train models using only one machine from a machine type.
+
+### Source Data
+
+#### Definition
+
+We first define key terms in this task: "machine type," "section," "source domain," "target domain," and "attributes.".
+
+-   "Machine type" indicates the type of machine, which in the development dataset is one of seven: fan, gearbox, bearing, slide rail, valve, ToyCar, and ToyTrain.
+-   A section is defined as a subset of the dataset for calculating performance metrics.
+-   The source domain is the domain under which most of the training data and some of the test data were recorded, and the target domain is a different set of domains under which some of the training data and some of the test data were recorded. There are differences between the source and target domains in terms of operating speed, machine load, viscosity, heating temperature, type of environmental noise, signal-to-noise ratio, etc.
+-   Attributes are parameters that define states of machines or types of noise.
+
+#### Description
+
+This dataset consists of seven machine types. For each machine type, one section is provided, and the section is a complete set of training and test data. For each section, this dataset provides (i) 990 clips of normal sounds in the source domain for training, (ii) ten clips of normal sounds in the target domain for training, and (iii) 100 clips each of normal and anomalous sounds for the test. The source/target domain of each sample is provided. Additionally, the attributes of each sample in the training and test data are provided in the file names and attribute csv files.
+
+#### Recording procedure
+
+Normal/anomalous operating sounds of machines and its related equipment are recorded. Anomalous sounds were collected by deliberately damaging target machines. For simplifying the task, we use only the first channel of multi-channel recordings; all recordings are regarded as single-channel recordings of a fixed microphone. We mixed a target machine sound with environmental noise, and only noisy recordings are provided as training/test data. The environmental noise samples were recorded in several real factory environments. We will publish papers on the dataset to explain the details of the recording procedure by the submission deadline.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+Not applicable.
+
+### Discussion of Biases
+
+Not applicable.
+
+### Other Known Limitations
+
+Not applicable.
+
+## Additional Information
+
+### Baseline system 
+
+[//]: # (todo)
+Two baseline systems are available on the Github repository. The baseline systems provide a simple entry-level approach that gives a reasonable performance in the dataset of Task 2. They are good starting points, especially for entry-level researchers who want to get familiar with the anomalous-sound-detection task.
+
+### Dataset Curators
+
+[//]: # (todo)
+Example: The SNLI corpus was developed by Samuel R. Bowman, Gabor Angeli, Christopher Potts, and Christopher D. Manning as part of the [Stanford NLP group](https://nlp.stanford.edu/).
+
+It was supported by a Google Faculty Research Award, a gift from Bloomberg L.P., the Defense Advanced Research Projects Agency (DARPA) Deep Exploration and Filtering of Text (DEFT) Program under Air Force Research Laboratory (AFRL) contract no. FA8750-13-2-0040, the National Science Foundation under grant no. IIS 1159679, and the Department of the Navy, Office of Naval Research, under grant no. N00014-10-1-0109.
+
+### Licensing Information - Condition of use
+
+The [original dataset](https://zenodo.org/record/7687464#.Y_9dd9LMLmH) was created jointly by **Hitachi, Ltd.** and **NTT Corporation** and is available under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) license.
+
+
+### Citation Information (original)
+
+If you use this dataset, please cite all the following papers. We will publish a paper on DCASE 2023 Task 2, so pleasure make sure to cite the paper, too.
+
+- Kota Dohi, Tomoya Nishida, Harsh Purohit, Ryo Tanabe, Takashi Endo, Masaaki Yamamoto, Yuki Nikaido, and Yohei Kawaguchi. MIMII DG: sound dataset for malfunctioning industrial machine investigation and inspection for domain generalization task. In arXiv e-prints: 2205.13879, 2022. [[URL](https://arxiv.org/abs/2205.13879)]
+- Noboru Harada, Daisuke Niizumi, Daiki Takeuchi, Yasunori Ohishi, Masahiro Yasuda, and Shoichiro Saito. ToyADMOS2: another dataset of miniature-machine operating sounds for anomalous sound detection under domain shift conditions. In Proceedings of the 6th Detection and Classification of Acoustic Scenes and Events 2021 Workshop (DCASE2021), 1–5. Barcelona, Spain, November 2021. [[URL](https://dcase.community/documents/workshop2021/proceedings/DCASE2021Workshop_Harada_6.pdf)]
+
+```
+@dataset{kota_dohi_2023_7687464,
+  author       = {Kota Dohi and
+                  Keisuke and
+                  Noboru and
+                  Daisuke and
+                  Yuma and
+                  Tomoya and
+                  Harsh and
+                  Takashi and
+                  Yohei},
+  title        = {DCASE 2023 Challenge Task 2 Development Dataset},
+  month        = mar,
+  year         = 2023,
+  publisher    = {Zenodo},
+  version      = {1.0},
+  doi          = {10.5281/zenodo.7687464},
+  url          = {https://doi.org/10.5281/zenodo.7687464}
+}
+```

data/.gitattributes

@@ -0,0 +1,3 @@
+config-spotlight-layout.json filter=lfs diff=lfs merge=lfs -text
+*.tag.gz filter=lfs diff=lfs merge=lfs -text
+dev_metadata.csv filter=lfs diff=lfs merge=lfs -text

data/config-spotlight-layout.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:671174dd0587e99ddcc999af2b9c149a4b3715564f6b838853e57256a176a4f3
+size 1380

data/dev_metadata.csv

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fd4c496569294420a1b5e4a5b9a8b130b740da5bd9d9d4714746627429b24535
+size 825327

data/dev_test.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c3163c1b0fc19edc4478bd27e4e2065e6a6f69b9a97a6e08a55d0e6b0b56e2d5
+size 364523414

data/dev_train.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:973e811e8911a2d264ec26d7ca0bb0d3f06d2bf1394cabcda4ef902d934b765f
+size 1830350107

dcase23-task2-enriched.py

@@ -0,0 +1,237 @@
+import os
+import datasets
+import datasets.info
+import pandas as pd
+from pathlib import Path
+from datasets import load_dataset
+from typing import Iterable, Dict, Optional, Union, List
+
+
+_CITATION = """\
+@dataset{kota_dohi_2023_7687464,
+  author       = {Kota Dohi and
+                  Keisuke and
+                  Noboru and
+                  Daisuke and
+                  Yuma and
+                  Tomoya and
+                  Harsh and
+                  Takashi and
+                  Yohei},
+  title        = {DCASE 2023 Challenge Task 2 Development Dataset},
+  month        = mar,
+  year         = 2023,
+  publisher    = {Zenodo},
+  version      = {1.0},
+  doi          = {10.5281/zenodo.7687464},
+  url          = {https://doi.org/10.5281/zenodo.7687464}
+}
+"""
+_LICENSE = "Creative Commons Attribution 4.0 International Public License"
+
+_METADATA_REG = r"attributes_\d+.csv"
+
+_NUM_TARGETS = 2
+_NUM_CLASSES = 7
+
+_TARGET_NAMES = ["normal", "anomaly"]
+_CLASS_NAMES = ["gearbox", "fan", "bearing", "slider", "ToyCar", "ToyTrain", "valve"]
+
+_HOMEPAGE = {
+    "dev": "https://zenodo.org/record/7687464#.Y_96q9LMLmH",
+    "add": None,
+    "eval": None,
+}
+
+DATA_URLS = {
+    "dev": {
+        "train": "data/dev_train.tar.gz",
+        "test": "data/dev_test.tar.gz",
+        "metadata": "data/dev_metadata.csv",
+    },
+    "add": None,
+    "eval": None,
+}
+
+STATS = {
+    "name": "Enriched Dataset of 'DCASE 2023 Challenge Task 2'",
+    "configs": {
+        'dev': {
+            'date': "Mar 1, 2023",
+            'version': "1.0.0",
+            'homepage': "https://zenodo.org/record/7687464#.ZABmANLMLmH",
+            "splits": ["train", "test"],
+        },
+        'add': {
+            'date': None,
+            'version': "0.0.0",
+            'homepage': None,
+            "splits": ["train", "test"],
+        },
+        'eval': {
+            'date': None,
+            'version': "0.0.0",
+            'homepage': None,
+            "splits": ["test"],
+        },
+    }
+}
+
+DATASET = {
+    'dev': 'DCASE 2023 Challenge Task 2 Development Dataset',
+    'add': 'DCASE 2023 Challenge Task 2 Additional Train Dataset',
+    'eval': 'DCASE 2023 Challenge Task 2 Evaluation Dataset',
+}
+
+_SPOTLIGHT_LAYOUT = "data/config-spotlight-layout.json"
+
+_SPOTLIGHT_RENAME = {
+    "audio": "original_audio",
+    "path": "audio",
+}
+
+
+class DCASE2023Task2DatasetConfig(datasets.BuilderConfig):
+    """BuilderConfig for DCASE2023Task2Dataset."""
+
+    def __init__(self, name, version, **kwargs):
+        self.release_date = kwargs.pop("release_date", None)
+        self.homepage = kwargs.pop("homepage", None)
+        self.data_urls = kwargs.pop("data_urls", None)
+        self.splits = kwargs.pop("splits", None)
+        self._rename = kwargs.pop("rename", None)
+        self._layout = kwargs.pop("layout", None)
+        description = (
+            f"Dataset for the DCASE 2023 Challenge Task 2 'First-Shot Unsupervised Anomalous Sound Detection "
+            f"for Machine Condition Monitoring'. released on {self.release_date}. Original data available under"
+            f"{self.homepage}. "
+            f"SPLIT: {name}."
+        )
+        super(DCASE2023Task2DatasetConfig, self).__init__(
+            name=name,
+            version=datasets.Version(version),
+            description=description,
+        )
+
+    def to_spotlight(self, data: Union[pd.DataFrame, datasets.Dataset]) -> pd.DataFrame:
+        if type(data) == datasets.Dataset:
+            df = data.to_pandas()
+            df["split"] = data.split
+            df["config"] = data.config_name
+
+            class_names = data.features["class"].names
+            df["class_name"] = df["class"].apply(lambda x: class_names[x])
+        elif type(data) == pd.DataFrame:
+            df = data
+        else:
+            raise TypeError("type(data) not in Union[pd.DataFrame, datasets.Dataset]")
+
+        df["file_path"] = df["path"]
+        df.rename(columns=self._rename, inplace=True)
+
+        return df.copy()
+
+    def get_layout(self):
+        return self._layout
+
+
+class DCASE2023Task2Dataset(datasets.GeneratorBasedBuilder):
+    """Dataset for the DCASE 2023 Challenge Task 2 "First-Shot Unsupervised Anomalous Sound Detection
+    for Machine Condition Monitoring"."""
+
+    VERSION = datasets.Version("0.0.2")
+
+    DEFAULT_CONFIG_NAME = "dev"
+
+    BUILDER_CONFIGS = [
+        DCASE2023Task2DatasetConfig(
+            name=key,
+            version=stats["version"],
+            dataset=DATASET[key],
+            homepage=_HOMEPAGE[key],
+            data_urls=DATA_URLS[key],
+            release_date=stats["date"],
+            splits=stats["splits"],
+            layout=_SPOTLIGHT_LAYOUT,
+            rename=_SPOTLIGHT_RENAME,
+        )
+        for key, stats in STATS["configs"].items()
+    ]
+
+    def _info(self):
+        features = datasets.Features(
+                {
+                    "audio": datasets.Audio(sampling_rate=16_000),
+                    "path": datasets.Value("string"),
+                    "section": datasets.Value("int64"),
+                    "d1p": datasets.Value("string"),
+                    "d1v": datasets.Value("string"),
+                    "d2p": datasets.Value("string"),
+                    "d2v": datasets.Value("string"),
+                    "d3p": datasets.Value("string"),
+                    "d3v": datasets.Value("string"),
+                    "label": datasets.ClassLabel(num_classes=_NUM_TARGETS, names=_TARGET_NAMES),
+                    "class": datasets.ClassLabel(num_classes=_NUM_CLASSES, names=_CLASS_NAMES),
+                    # "baseline-embeddings": datasets.Array2D(shape=(64, 1), dtype='float32'), # todo: add
+                }
+            )
+
+        return datasets.DatasetInfo(
+            # This is the description that will appear on the datasets page.
+            description=self.config.description,
+            features=features,
+            supervised_keys=datasets.info.SupervisedKeysData("label"),
+            homepage=self.config.homepage,
+            license=_LICENSE,
+            citation=_CITATION,
+        )
+
+    def _split_generators(
+            self,
+            dl_manager: datasets.DownloadManager
+    ):
+        """Returns SplitGenerators."""
+        dl_manager.download_config.ignore_url_params = True
+        audio_path = {}
+        local_extracted_archive = {}
+        split_type = {"train": datasets.Split.TRAIN, "test": datasets.Split.TEST}
+
+        for split in split_type:
+            audio_path[split] = dl_manager.download(self.config.data_urls[split])
+            local_extracted_archive[split] = dl_manager.extract(
+                audio_path[split]) if not dl_manager.is_streaming else None
+
+        return [
+            datasets.SplitGenerator(
+                name=split_type[split],
+                gen_kwargs={
+                    "split": split,
+                    "local_extracted_archive": local_extracted_archive[split],
+                    "audio_files": dl_manager.iter_archive(audio_path[split]),
+                    "metadata_file": dl_manager.download_and_extract(self.config.data_urls["metadata"]),
+                },
+            ) for split in split_type
+        ]
+
+    def _generate_examples(
+        self,
+        split: str,
+        local_extracted_archive: Union[Dict, List],
+        audio_files: Optional[Iterable],
+        metadata_file: Optional[str],
+    ):
+        """Yields examples."""
+        metadata = pd.read_csv(metadata_file)
+        data_fields = list(self._info().features.keys())
+
+        id_ = 0
+        for path, f in audio_files:
+            lookup = Path(path).parent.name + "/" + Path(path).name
+            if lookup in metadata["path"].values:
+                path = os.path.join(local_extracted_archive, path) if local_extracted_archive else path
+                audio = {"path": path, "bytes": f.read()}
+                result = {field: None for field in data_fields}
+                result.update(metadata[metadata["path"] == lookup].T.squeeze().to_dict())
+                result["path"] = path
+                yield id_, {**result, "audio": audio}
+                id_ += 1