Create README.md

README.md

@@ -0,0 +1,85 @@
+---
+library_name: mlx-audio-plus
+base_model:
+- ResembleAI/chatterbox
+tags:
+- mlx
+- multilingual
+- tts
+- text-to-speech
+- japanese
+language:
+- ar  # Arabic
+- da  # Danish
+- de  # German
+- el  # Greek
+- en  # English
+- es  # Spanish
+- fi  # Finnish
+- fr  # French
+- he  # Hebrew
+- hi  # Hindi
+- it  # Italian
+- ja  # Japanese
+- ko  # Korean
+- ms  # Malay
+- nl  # Dutch
+- "no"  # Norwegian
+- pl  # Polish
+- pt  # Portuguese
+- ru  # Russian
+- sv  # Swedish
+- sw  # Swahili
+- tr  # Turkish
+- zh  # Chinese
+pipeline_tag: text-to-speech
+---
+
+# {model_name}
+
+Chatterbox Multilingual TTS converted to MLX format for Apple Silicon devices.
+
+## 🌍 Supported Languages (23 languages)
+
+Arabic, Danish, German, Greek, English, Spanish, Finnish, French, Hebrew, Hindi,
+Italian, **Japanese**, Korean, Malay, Dutch, Norwegian, Polish, Portuguese,
+Russian, Swedish, Swahili, Turkish, Chinese
+
+## 📥 Installation
+```bash
+pip install -U mlx-audio-plus
+```
+
+## 🚀 Usage
+
+### Command Line
+```bash
+mlx_audio.tts.generate \\
+    --model {model_name} \\
+    --text "こんにちは、元気ですか？" \\
+    --ref_audio reference.wav
+```
+
+### Python
+```python
+from mlx_audio.tts.generate import generate_audio
+
+generate_audio(
+    text="こんにちは、元気ですか？",
+    model="{model_name}",
+    ref_audio="reference.wav",
+    file_prefix="output",
+)
+```
+
+## 📊 Model Details
+
+- **Base Model**: ResembleAI/chatterbox
+- **Tokenizer**: 2454 tokens (Multilingual)
+- **Quantization**: {'4-bit' if '4bit' in model_name else '8-bit' if '8bit' in model_name else 'fp16'}
+- **Framework**: MLX (Apple Silicon optimized)
+
+## 🔗 Related
+
+- Original PyTorch model: [ResembleAI/chatterbox](https://huggingface.co/ResembleAI/chatterbox)
+- S3Tokenizer: [mlx-community/S3TokenizerV2](https://huggingface.co/mlx-community/S3TokenizerV2)