Upload README.md with huggingface_hub

README.md

@@ -1,47 +1,41 @@
 ---
-dataset_info:
-  features:
-  - name: region
-    dtype: string
-  - name: province_code
-    dtype: int64
-  - name: province_name
-    dtype: string
-  - name: filename
-    dtype: string
-  - name: text
-    dtype: string
-  - name: speakerID
-    dtype: string
-  - name: gender
-    dtype: int64
-  - name: audio
-    dtype:
-      audio:
-        sampling_rate: 16000
-  - name: new_province_name
-    dtype: string
-  - name: length
-    dtype: float64
-  splits:
-  - name: train
-    num_bytes: 4732880672
-    num_examples: 15023
-  - name: test
-    num_bytes: 635471319
-    num_examples: 2026
-  - name: valid
-    num_bytes: 598490941
-    num_examples: 1900
-  download_size: 5962186491
-  dataset_size: 5966842932
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
-  - split: valid
-    path: data/valid-*
+language:
+- vi
+license: other
+task_categories:
+- audio-classification
+- automatic-speech-recognition
+pretty_name: ViMD Truncated 10s (16kHz)
+size_categories:
+- 10K<n<100K
 ---
+
+# ViMD Truncated 10s — 16kHz
+
+Preprocessed version of **ViMD** (Nguyen et al., EMNLP 2024) for Dialect Identification.
+
+## Preprocessing applied
+- **Resample:** 44.1kHz (original) → **16kHz, mono**
+- **Truncate:** only the **FIRST 10 SECONDS** of each audio are kept
+  (files shorter than 10s are kept intact). **1 original file = 1 sample.**
+  This follows the truncation strategy of Lu et al. (2020), NOT chunking.
+- **Splits:** original ViMD train/valid/test kept unchanged (speaker-exclusive).
+
+## New column vs. original ViMD
+- `new_province`: province name **after the administrative merger** (34 classes),
+  mapped from the original `province` column (63 classes).
+
+## Usage
+```python
+from datasets import load_dataset
+ds = load_dataset("tannhoo06/ViMD_preprocessing")
+```
+
+## EDA without downloading audio
+```python
+import pandas as pd
+meta = pd.read_parquet("hf://datasets/tannhoo06/ViMD_preprocessing/metadata.parquet")
+```
+
+## Citation
+Please cite the original ViMD paper (Nguyen et al., EMNLP 2024).