Update model card with ONNX usage

README.md

@@ -5,16 +5,22 @@ pipeline_tag: text-to-speech
 tags:
   - kokoro
   - vietnamese
-  - tts
   - text-to-speech
-  - vig2p
+  - onnx
 license: apache-2.0
-library_name: kokoro
 ---
 
 # Kokoro Vietnamese
 
-Vietnamese Kokoro TTS inference model. Vietnamese G2P is handled by [`vig2p`](https://pypi.org/project/vig2p/).
+Fine-tuned Vietnamese Kokoro TTS artifacts.
+
+## Files
+
+- `kokoro_vi.pth`: PyTorch Kokoro `KModel` checkpoint for inference.
+- `kokoro_vi.onnx`: ONNX Runtime export of the acoustic model.
+- `kokoro_vi_voicepack.pt`: default Vietnamese voicepack.
+- `config.json`: Kokoro config/vocab used by both PyTorch and ONNX inference.
+- `voicepacks/*.pt`: additional Vietnamese voicepacks.
 
 ## Install
 
@@ -24,70 +30,43 @@ cd Kokoro-Vietnamese
 pip install -e .
 ```
 
-Install the PyTorch build that matches your machine first if you need CUDA.
-
-## Voices
-
-Use these names with `voice=...` in Python or `--voice ...` in the CLI.
-
-| Voice | Name |
-| --- | --- |
-| `diem_trinh` | Diễm Trinh |
-| `hung_thinh` | Hưng Thịnh |
-| `mai_linh` | Mai Linh |
-| `mai_loan` | Mai Loan |
-| `manh_dung` | Mạnh Dũng |
-| `my_yen` | Mỹ Yến |
-| `ngoc_huyen` | Ngọc Huyền |
-| `phat_tai` | Phát Tài |
-| `thanh_dat` | Thành Đạt |
-| `thuc_trinh` | Thục Trinh |
-| `tuan_ngoc` | Tuấn Ngọc |
-| `storyvert` | storyvert |
-| `duc_an` | Đức An |
-| `duc_duy` | đức duy |
-
-## Python API
-
-```python
-import soundfile as sf
-from kokoro_vietnamese import KokoroVietnamese
-
-tts = KokoroVietnamese(device="cuda", voice="diem_trinh")
-
-audio, phonemes = tts.synthesize(
-    "Giữa một buổi chiều yên tĩnh, cô ấy kể lại câu chuyện bằng một giọng nói ấm áp và chậm rãi."
-)
+For ONNX Runtime:
 
-sf.write("sample.wav", audio, 24000)
-print(phonemes)
-```
-
-Use another voice:
-
-```python
-tts = KokoroVietnamese(device="cuda", voice="mai_linh")
-audio, phonemes = tts.synthesize("Hôm nay trời trong xanh, gió thổi nhẹ qua hiên nhà.")
+```bash
+pip install -e ".[onnx]"
 ```
 
-## CLI
+## PyTorch Inference
 
 ```bash
 kokoro-vietnamese \
-  --text "Giữa một buổi chiều yên tĩnh, cô ấy kể lại câu chuyện bằng một giọng nói ấm áp và chậm rãi." \
+  --text "Xin chào, hôm nay tôi đang kiểm tra giọng đọc tiếng Việt." \
+  --output outputs/sample.wav \
   --voice diem_trinh \
-  --output sample.wav \
   --device cuda
 ```
 
-List voices:
+## ONNX Runtime Inference
 
 ```bash
-kokoro-vietnamese --list-voices
+kokoro-vietnamese-onnx \
+  --text "Tường nhà khách đã được sơn lại." \
+  --output outputs/onnx.wav \
+  --device cpu \
+  --print-phonemes
 ```
 
-## Notes
+The ONNX CLI downloads `kokoro_vi.onnx`, `kokoro_vi_voicepack.pt`, and
+`config.json` from this repository when local paths are not provided. Install
+`onnxruntime-gpu` and pass `--device cuda` to use CUDAExecutionProvider when
+available.
+
+## Export ONNX Yourself
+
+```bash
+kokoro-vietnamese-export-onnx \
+  --output outputs/kokoro_vi.onnx
+```
 
-- Text is split by sentence punctuation and merged with a short crossfade.
-- The model expects Vietnamese text normalized enough for `vig2p`.
-- The voicepacks are derived from the LarVoice multi-speaker training set and are distributed as inference artifacts.
+Vietnamese G2P is handled by `vig2p`, matching the GitHub inference and
+training code.