Upload README.md with huggingface_hub

README.md

@@ -13,13 +13,35 @@ dataset_info:
     dtype: string
   splits:
   - name: train
-    num_bytes: 29499246
+    num_bytes: unknown
     num_examples: 9000
-  download_size: 6852685
-  dataset_size: 29499246
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+  download_size: unknown
+  dataset_size: unknown
 ---
+
+# LLASA Stage 1 Training Dataset (Text-Phoneme Conversion)
+
+This dataset contains filtered text-phoneme pairs for Stage 1 curriculum learning in LLASA.
+
+## Purpose
+
+Stage 1 training teaches the model text ↔ phoneme conversion using LLAMA's existing text understanding capabilities.
+
+## Columns
+
+- `phoneme_text_sequence`: Phoneme tokens → Text conversion sequence ("<|ph_0068|>... Convert into text: Hello world")
+- `text_phoneme_sequence`: Text → Phoneme tokens conversion sequence ("Hello world Convert into phonemes: <|ph_0068|>...")
+- `text`: Original text for reference
+- `phonemes_ipa`: Original IPA phonemes for verification
+- `phonemes_hex`: Hex-encoded phoneme tokens for verification
+
+## Filtering
+
+The dataset has been filtered to exclude:
+- Invalid MFA phonemizations where phonemes equal the normalized text (fallback cases like "spn")
+
+## Usage
+
+Use this dataset for Stage 1 training with `--training_stage words_phonemes` in `train_llasa_with_phonemes.py`.
+
+Total samples: 9000