Initial commit: Vietnamese IPA Dataset

- Created comprehensive Vietnamese IPA dataset with 50 common words
- Added IPA transcriptions with tone marks for each word
- Generated MP3 audio files using Google Text-to-Speech
- Implemented Python scripts for dataset management and audio generation
- Added Hugging Face compatible README with proper dataset card format
- Set up project with uv package manager
- Applied ruff linting and formatting standards
- Included example usage script for interactive exploration

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>

.python-version

@@ -0,0 +1 @@
+3.13

README.md

@@ -0,0 +1,204 @@
+---
+language:
+- vi
+pretty_name: Vietnamese IPA Dataset
+tags:
+- audio
+- text-to-speech
+- vietnamese
+- ipa
+- phonetics
+- pronunciation
+license: mit
+task_categories:
+- text-to-speech
+- automatic-speech-recognition
+size_categories:
+- n<1K
+---
+
+# Vietnamese IPA Dataset
+
+A comprehensive Vietnamese IPA (International Phonetic Alphabet) dataset with word pronunciations and MP3 audio files for text-to-speech and pronunciation learning applications.
+
+## Dataset Description
+
+### Dataset Summary
+
+This dataset contains 50 common Vietnamese words with their IPA (International Phonetic Alphabet) transcriptions and corresponding audio files. It's designed for:
+- Text-to-speech systems development
+- Vietnamese pronunciation learning
+- Phonetic research
+- Language learning applications
+
+### Supported Tasks
+
+- **Text-to-Speech**: Generate Vietnamese speech from text
+- **Pronunciation Learning**: Learn correct Vietnamese pronunciation with IPA
+- **Phonetic Analysis**: Study Vietnamese phonetics with accurate IPA transcriptions
+
+### Languages
+
+Vietnamese (`vi`)
+
+## Dataset Structure
+
+### Data Instances
+
+Each instance contains:
+- A Vietnamese word or phrase
+- Its IPA transcription with tone marks
+- Path to the corresponding MP3 audio file
+
+### Data Fields
+
+- `word` (string): Vietnamese word or phrase
+- `ipa` (string): IPA transcription with tone marks
+- `audio_file` (string): Path to MP3 audio file
+
+### Data Splits
+
+The dataset contains a single training split with 50 examples.
+
+## Dataset Creation
+
+### Curation Rationale
+
+This dataset was created to provide a simple, accessible resource for Vietnamese pronunciation with accurate IPA transcriptions and audio, addressing the lack of small-scale Vietnamese phonetic datasets.
+
+### Source Data
+
+#### Initial Data Collection
+
+Words were selected from common Vietnamese vocabulary including:
+- Greetings and basic phrases
+- Family terms
+- Numbers
+- Time expressions
+- Common nouns and verbs
+
+### Annotations
+
+#### Annotation Process
+
+IPA transcriptions were created following standard Vietnamese phonetic conventions, including tone marks:
+- ˧˧ (33): Level tone (ngang)
+- ˨˩ (21): Falling tone (huyền)
+- ˧˩ˀ (32ˀ): Falling-rising tone (hỏi)
+- ˧˥ (35): Rising tone (sắc)
+- ˧˩˧ (313): Broken tone (ngã)
+- ˨˩ˀ (21ˀ): Drop tone (nặng)
+
+Audio files were generated using Google Text-to-Speech (gTTS) for consistency.
+
+## Usage
+
+### Quick Start
+
+```python
+import pandas as pd
+
+# Load the dataset
+df = pd.read_csv('vietnamese_ipa_dataset.csv')
+
+# Access word, IPA, and audio file
+for idx, row in df.iterrows():
+    word = row['word']
+    ipa = row['ipa']
+    audio_file = row['audio_file']
+    print(f"{word}: {ipa} -> {audio_file}")
+```
+
+### With Hugging Face Datasets
+
+```python
+from datasets import load_dataset
+
+# Load from Hugging Face Hub (once uploaded)
+dataset = load_dataset("username/vietnamese-ipa-dataset")
+
+# Access the data
+for example in dataset['train']:
+    print(f"{example['word']}: {example['ipa']}")
+```
+
+### Local Development
+
+This project uses `uv` for dependency management:
+
+```bash
+# Install dependencies
+uv sync
+
+# Generate audio files
+uv run python generate_audio.py generate
+
+# Display dataset
+uv run python generate_audio.py display
+
+# Add new word
+uv run python generate_audio.py add "xin lỗi" "sin˧˧ loj˧˩"
+
+# Interactive example
+uv run python example_usage.py
+```
+
+## Example Data
+
+| Word | IPA | Audio File |
+|------|-----|------------|
+| xin chào | sin˧˧ caːw˨˩ | audio/xin_chao.mp3 |
+| cảm ơn | kaːm˧˩ ʔəːn˧˧ | audio/cam_on.mp3 |
+| Việt Nam | viət˧˩ˀ naːm˧˧ | audio/viet_nam.mp3 |
+| nước | nɨək˧˥ | audio/nuoc.mp3 |
+| yêu | iəw˧˧ | audio/yeu.mp3 |
+
+## Considerations for Using the Data
+
+### Social Impact
+
+This dataset promotes Vietnamese language learning and preservation through accurate phonetic representations.
+
+### Limitations
+
+- Limited to 50 common words (suitable for basic applications)
+- Audio generated via TTS, not native speaker recordings
+- IPA transcriptions follow Northern Vietnamese dialect
+- May not capture all regional pronunciation variations
+
+### Recommendations
+
+- For production systems, consider native speaker recordings
+- Expand vocabulary for comprehensive coverage
+- Add regional dialect variations if needed
+
+## Additional Information
+
+### Dataset Curators
+
+Created for educational and research purposes in Vietnamese phonetics and pronunciation.
+
+### Licensing Information
+
+This dataset is released under the MIT License.
+
+### Citation Information
+
+If you use this dataset, please cite:
+
+```bibtex
+@dataset{vietnamese_ipa_2025,
+  title = {Vietnamese IPA Dataset},
+  year = {2025},
+  publisher = {GitHub},
+  url = {https://github.com/yourusername/vietnamese-ipa-dataset}
+}
+```
+
+### Contributions
+
+Contributions are welcome! Please feel free to:
+- Add more words with IPA transcriptions
+- Improve existing IPA transcriptions
+- Add native speaker recordings
+- Include regional dialect variations