Upload README.md with huggingface_hub

README.md

@@ -1,65 +1,98 @@
 ---
-dataset_info:
-  features:
-  - name: id
-    dtype: string
-  - name: audio_left
-    dtype:
-      audio:
-        sampling_rate: 16000
-        decode: false
-  - name: audio_right
-    dtype:
-      audio:
-        sampling_rate: 16000
-        decode: false
-  - name: environment
-    dtype: string
-  - name: rec_id
-    dtype: string
-  - name: cut_id
-    dtype: string
-  - name: snip_id
-    dtype: string
-  splits:
-  - name: cocktail_party
-    num_bytes: 458347400
-    num_examples: 716
-  - name: in_traffic
-    num_bytes: 640146000
-    num_examples: 1000
-  - name: in_vehicle
-    num_bytes: 700319724
-    num_examples: 1094
-  - name: music
-    num_bytes: 1914664722
-    num_examples: 2991
-  - name: quiet_indoors
-    num_bytes: 608781699
-    num_examples: 951
-  - name: reverberant
-    num_bytes: 644640113
-    num_examples: 1007
-  - name: wind_turbulence
-    num_bytes: 661916134
-    num_examples: 1034
-  download_size: 6463832667
-  dataset_size: 5628815792
-configs:
-- config_name: default
-  data_files:
-  - split: cocktail_party
-    path: data/cocktail_party-*
-  - split: in_traffic
-    path: data/in_traffic-*
-  - split: in_vehicle
-    path: data/in_vehicle-*
-  - split: music
-    path: data/music-*
-  - split: quiet_indoors
-    path: data/quiet_indoors-*
-  - split: reverberant
-    path: data/reverberant-*
-  - split: wind_turbulence
-    path: data/wind_turbulence-*
+license: other
+license_name: academic-research
+license_link: https://www.hz-ol.shop/en/hear-ds.html
+task_categories:
+  - audio-classification
+  - automatic-speech-recognition
+language:
+  - en
+  - de
+tags:
+  - hearing-aids
+  - speech-enhancement
+  - acoustic-scenes
+  - binaural-audio
+  - noise
+size_categories:
+  - 1K<n<10K
 ---
+
+# HEAR-DS Background Audio (16kHz)
+
+Binaural background audio recordings from the **HEAR-DS** (Hearing Aid Research Database of Sounds) dataset, downsampled to 16kHz and chunked into 10-second segments for speech enhancement and acoustic scene classification research.
+
+## Dataset Description
+
+This dataset contains background noise recordings from 7 acoustic environments, captured using in-the-canal (ITC) hearing aid microphones. Each sample includes stereo (left/right ear) audio.
+
+### Environments
+
+| Split | Environment | Samples |
+|-------|-------------|---------|
+| `cocktail_party` | Multi-speaker social settings | 716 |
+| `in_traffic` | Road traffic noise | 1,000 |
+| `in_vehicle` | Inside vehicles (car, bus, train) | 1,094 |
+| `music` | Various music genres | 2,991 |
+| `quiet_indoors` | Low-noise indoor environments | 951 |
+| `reverberant` | Reverberant spaces | 1,007 |
+| `wind_turbulence` | Outdoor wind noise | 1,034 |
+| **Total** | | **8,793** |
+
+### Features
+
+- `id`: Unique sample identifier
+- `audio_left`: Left ear ITC microphone recording (16kHz, mono)
+- `audio_right`: Right ear ITC microphone recording (16kHz, mono)
+- `environment`: Acoustic environment category
+- `rec_id`: Original recording session ID
+- `cut_id`: Cut/segment ID within recording
+- `snip_id`: 10-second chunk index
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+# Load all environments
+ds = load_dataset("nkdem/HEAR-DS-16k")
+
+# Load specific environment
+traffic = load_dataset("nkdem/HEAR-DS-16k", split="in_traffic")
+
+# Access a sample
+sample = traffic[0]
+print(sample["environment"])  # "InTraffic"
+print(sample["audio_left"]["array"].shape)  # (160000,) - 10 seconds at 16kHz
+```
+
+## Processing Details
+
+- **Original sample rate**: 48kHz
+- **Target sample rate**: 16kHz (downsampled with librosa)
+- **Chunk duration**: 10 seconds (160,000 samples)
+- **Channels**: Mono per ear (stereo pair preserved as separate columns)
+- **Microphone**: In-The-Canal (ITC) hearing aid microphones
+
+## Citation & Attribution
+
+This dataset is derived from **HEAR-DS**, created by Hörzentrum Oldenburg:
+
+> Hohmann, V., et al. "The HEAR-DS database of acoustic scenes and events for hearing aid research."
+> Hörzentrum Oldenburg gGmbH.
+
+**Original source**: [https://www.hz-ol.shop/en/hear-ds.html](https://www.hz-ol.shop/en/hear-ds.html)
+
+If you use this dataset, please cite the original HEAR-DS database and acknowledge Hörzentrum Oldenburg.
+
+## Intended Use
+
+This dataset is intended for:
+- Speech enhancement model training (as noise source for augmentation)
+- Acoustic scene classification research
+- Hearing aid algorithm development
+- Audio machine learning research
+
+## Licence
+
+This is a processed version of HEAR-DS for research purposes. Please refer to the [original HEAR-DS page](https://www.hz-ol.shop/en/hear-ds.html) for licensing terms. Some components may have additional restrictions from third-party sources (CHiME, GTZan).