Datasets:
Add metadata (task categories, license, tags, language) and improve dataset card structure
#2
by
nielsr
HF Staff
- opened
README.md
CHANGED
|
@@ -1,12 +1,30 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
# RIR-Mega
|
| 2 |
|
|
|
|
|
|
|
| 3 |
RIR-Mega provides thousands of simulated room impulse responses for research in dereverberation, robust speech recognition, and acoustic scene analysis.
|
| 4 |
This Hugging Face release hosts a lightweight, representative subset — 1 000 linear-array and 3 000 circular-array RIRs — for quick exploration, tutorials, and reproducible baselines.
|
| 5 |
|
| 6 |
The complete 50 000-RIR archive is permanently preserved on Zenodo and described in the accompanying paper:
|
| 7 |
|
| 8 |
-
🗂 Full dataset (Zenodo DOI): (https://doi.org/10.5281/zenodo.17387402)
|
| 9 |
-
💾 Code + tools: (https://github.com/mandip42/rirmega)
|
| 10 |
🤗 Subset for streaming: (https://huggingface.co/datasets/mandipgoswami/rirmega)
|
| 11 |
📦 Technical Paper: ([arxiv.org/abs/2510.18917](https://doi.org/10.48550/arXiv.2510.18917))
|
| 12 |
|
|
@@ -18,28 +36,28 @@ The complete 50 000-RIR archive is permanently preserved on Zenodo and described
|
|
| 18 |
- *(optional)* `data-mini/` — tiny subset for quick demos and Spaces
|
| 19 |
|
| 20 |
## Contents
|
| 21 |
-
| Folder
|
| 22 |
| ----------------------------------------- | ------------------------------------------------------------------------------ |
|
| 23 |
-
| `data/audio/linear`
|
| 24 |
-
| `data/audio/circular`
|
| 25 |
| `data/metadata/metadata.csv` / `.parquet` | Compact schema linking each file to acoustic metrics and simulation parameters |
|
| 26 |
-
| `rirmega/dataset.py`
|
| 27 |
-
| `benchmarks/rt60_regression/`
|
| 28 |
-
| `scripts/`
|
| 29 |
-
| `figs/`
|
| 30 |
|
| 31 |
|
| 32 |
## 📦 Schema (compact)
|
| 33 |
-
| Column
|
| 34 |
| -------------------------------------- | ----------------------------------------------------------------------------- |
|
| 35 |
-
| `id`
|
| 36 |
-
| `family`
|
| 37 |
-
| `split`
|
| 38 |
-
| `fs`
|
| 39 |
-
| `wav`
|
| 40 |
-
| `room_size`, `absorption`, `max_order` | simulation parameters
|
| 41 |
-
| `metrics`
|
| 42 |
-
| `rng_seed`
|
| 43 |
|
| 44 |
## 🚀 Getting started
|
| 45 |
|
|
@@ -71,9 +89,9 @@ python benchmarks/rt60_regression/train_rt60.py --target rt60
|
|
| 71 |
## Technical Validation
|
| 72 |
A random subset of 1 000 samples was analyzed for internal consistency.
|
| 73 |
The RT60 values derived from Schroeder energy decay curves correlated strongly with the metadata values:
|
| 74 |
-
| Metric
|
| 75 |
| ---------------------- | ----------- | ------- | -------- |
|
| 76 |
-
| RT60 (metadata vs EDC) | 0.96
|
| 77 |
|
| 78 |
|
| 79 |
### Reference numbers (example)
|
|
@@ -104,11 +122,4 @@ Please cite the dataset:
|
|
| 104 |
doi={10.5281/zenodo.17387402},
|
| 105 |
url={https://github.com/mandip42/rirmega}
|
| 106 |
}
|
| 107 |
-
```
|
| 108 |
-
|
| 109 |
-
## 📜 Licenses
|
| 110 |
-
- Metadata & docs: CC BY 4.0
|
| 111 |
-
- Audio: specify here (e.g., CC BY-NC 4.0). If mixed, list per-subset.
|
| 112 |
-
|
| 113 |
-
## 🏷️ Tags
|
| 114 |
-
audio, rir, acoustics, dereverberation, robust-asr, simulation, room-acoustics
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language:
|
| 3 |
+
- en
|
| 4 |
+
task_categories:
|
| 5 |
+
- audio-to-audio
|
| 6 |
+
- automatic-speech-recognition
|
| 7 |
+
- audio-classification
|
| 8 |
+
license: cc-by-nc-4.0
|
| 9 |
+
tags:
|
| 10 |
+
- audio
|
| 11 |
+
- rir
|
| 12 |
+
- acoustics
|
| 13 |
+
- dereverberation
|
| 14 |
+
- robust-asr
|
| 15 |
+
- simulation
|
| 16 |
+
- room-acoustics
|
| 17 |
+
---
|
| 18 |
+
|
| 19 |
# RIR-Mega
|
| 20 |
|
| 21 |
+
[Paper](https://huggingface.co/papers/2510.18917) | [Code](https://github.com/mandip42/rirmega) | [Project page (Zenodo)](https://doi.org/10.5281/zenodo.17387402)
|
| 22 |
+
|
| 23 |
RIR-Mega provides thousands of simulated room impulse responses for research in dereverberation, robust speech recognition, and acoustic scene analysis.
|
| 24 |
This Hugging Face release hosts a lightweight, representative subset — 1 000 linear-array and 3 000 circular-array RIRs — for quick exploration, tutorials, and reproducible baselines.
|
| 25 |
|
| 26 |
The complete 50 000-RIR archive is permanently preserved on Zenodo and described in the accompanying paper:
|
| 27 |
|
|
|
|
|
|
|
| 28 |
🤗 Subset for streaming: (https://huggingface.co/datasets/mandipgoswami/rirmega)
|
| 29 |
📦 Technical Paper: ([arxiv.org/abs/2510.18917](https://doi.org/10.48550/arXiv.2510.18917))
|
| 30 |
|
|
|
|
| 36 |
- *(optional)* `data-mini/` — tiny subset for quick demos and Spaces
|
| 37 |
|
| 38 |
## Contents
|
| 39 |
+
| Folder | Description |
|
| 40 |
| ----------------------------------------- | ------------------------------------------------------------------------------ |
|
| 41 |
+
| `data/audio/linear` | 1 000 RIRs simulated for linear microphone arrays |
|
| 42 |
+
| `data/audio/circular` | 3 000 RIRs simulated for circular arrays |
|
| 43 |
| `data/metadata/metadata.csv` / `.parquet` | Compact schema linking each file to acoustic metrics and simulation parameters |
|
| 44 |
+
| `rirmega/dataset.py` | Hugging Face Datasets loader (supports streaming) |
|
| 45 |
+
| `benchmarks/rt60_regression/` | Baseline RT60 regression example |
|
| 46 |
+
| `scripts/` | Validation + checksum utilities |
|
| 47 |
+
| `figs/` | Overview and validation plots for reference |
|
| 48 |
|
| 49 |
|
| 50 |
## 📦 Schema (compact)
|
| 51 |
+
| Column | Meaning |
|
| 52 |
| -------------------------------------- | ----------------------------------------------------------------------------- |
|
| 53 |
+
| `id` | unique identifier |
|
| 54 |
+
| `family` | “linear” or “circular” |
|
| 55 |
+
| `split` | train / valid / test |
|
| 56 |
+
| `fs` | sampling rate (Hz) |
|
| 57 |
+
| `wav` | relative path to audio file |
|
| 58 |
+
| `room_size`, `absorption`, `max_order` | simulation parameters |
|
| 59 |
+
| `metrics` | JSON string with `rt60`, `drr_db`, `c50_db`, `c80_db`, and band-limited RT60s |
|
| 60 |
+
| `rng_seed` | random seed for reproducibility |
|
| 61 |
|
| 62 |
## 🚀 Getting started
|
| 63 |
|
|
|
|
| 89 |
## Technical Validation
|
| 90 |
A random subset of 1 000 samples was analyzed for internal consistency.
|
| 91 |
The RT60 values derived from Schroeder energy decay curves correlated strongly with the metadata values:
|
| 92 |
+
| Metric | Correlation | MAE (s) | RMSE (s) |
|
| 93 |
| ---------------------- | ----------- | ------- | -------- |
|
| 94 |
+
| RT60 (metadata vs EDC) | 0.96 | 0.013 | 0.022 |
|
| 95 |
|
| 96 |
|
| 97 |
### Reference numbers (example)
|
|
|
|
| 122 |
doi={10.5281/zenodo.17387402},
|
| 123 |
url={https://github.com/mandip42/rirmega}
|
| 124 |
}
|
| 125 |
+
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|