Update README.md

README.md

@@ -1,3 +1,164 @@
----
-license: apache-2.0
----
+---
+license: cc-by-nc-4.0
+datasets:
+- facebook/multilingual_librispeech
+- parler-tts/libritts_r_filtered
+- amphion/Emilia-Dataset
+- parler-tts/mls_eng
+language:
+- en
+- zh
+- ja
+- ko
+pipeline_tag: text-to-speech
+---
+## Model Description
+
+OuteTTS-0.2-500M is our improved successor to the v0.1 release. 
+The model maintains the same approach of using audio prompts without architectural changes to the foundation model itself. 
+Built upon the Qwen-2.5-0.5B, this version was trained on larger and more diverse datasets, resulting in significant improvements across all aspects of performance.
+
+Special thanks to **Hugging Face** for providing GPU grant that supported the training of this model.
+
+## Key Improvements
+
+- **Enhanced Accuracy**: Significantly improved prompt following and output coherence compared to the previous version
+- **Natural Speech**: Produces more natural and fluid speech synthesis
+- **Expanded Vocabulary**: Trained on over 5 billion audio prompt tokens
+- **Voice Cloning**: Improved voice cloning capabilities with greater diversity and accuracy
+- **Multilingual Support**: New experimental support for Chinese, Japanese, and Korean languages
+
+## Speech Demo
+
+<video width="1280" height="720" controls>
+  <source src="https://huggingface.co/OuteAI/OuteTTS-0.2-500M-GGUF/resolve/main/media/demo.mp4" type="video/mp4">
+Your browser does not support the video tag.
+</video>
+
+## Usage
+
+### Installation
+
+[![GitHub](https://img.shields.io/badge/GitHub-OuteTTS-181717?logo=github)](https://github.com/edwko/OuteTTS)
+
+```bash
+pip install outetts
+```
+
+### Interface Usage
+
+```python
+import outetts
+
+# Configure the model
+model_config = outetts.HFModelConfig_v1(
+    model_path="OuteAI/OuteTTS-0.2-500M",
+    language="en",  # Supported languages in v0.2: en, zh, ja, ko
+)
+
+# Initialize the interface
+interface = outetts.InterfaceHF(model_version="0.2", cfg=model_config)
+
+# Optional: Create a speaker profile (use a 10-15 second audio clip)
+# speaker = interface.create_speaker(
+#     audio_path="path/to/audio/file",
+#     transcript="Transcription of the audio file."
+# )
+
+# Optional: Save and load speaker profiles
+# interface.save_speaker(speaker, "speaker.json")
+# speaker = interface.load_speaker("speaker.json")
+
+# Optional: Load speaker from default presets
+interface.print_default_speakers()
+speaker = interface.load_default_speaker(name="male_1")
+
+output = interface.generate(
+    text="Speech synthesis is the artificial production of human speech. A computer system used for this purpose is called a speech synthesizer, and it can be implemented in software or hardware products.",
+    # Lower temperature values may result in a more stable tone,
+    # while higher values can introduce varied and expressive speech
+    temperature=0.1,
+    repetition_penalty=1.1,
+    max_length=4096,
+
+    # Optional: Use a speaker profile for consistent voice characteristics
+    # Without a speaker profile, the model will generate a voice with random characteristics
+    speaker=speaker,
+)
+
+# Save the synthesized speech to a file
+output.save("output.wav")
+
+# Optional: Play the synthesized speech
+# output.play()
+```
+
+## Using GGUF Model
+
+```python
+# Configure the GGUF model
+model_config = outetts.GGUFModelConfig_v1(
+    model_path="local/path/to/model.gguf",
+    language="en", # Supported languages in v0.2: en, zh, ja, ko
+    n_gpu_layers=0,
+)
+
+# Initialize the GGUF interface
+interface = outetts.InterfaceGGUF(model_version="0.2", cfg=model_config)
+```
+
+# Configure the model with bfloat16 and flash attention
+
+```python
+import outetts
+import torch
+
+model_config = outetts.HFModelConfig_v1(
+    model_path="OuteAI/OuteTTS-0.2-500M",
+    language="en",  # Supported languages in v0.2: en, zh, ja, ko
+    dtype=torch.bfloat16,
+    additional_model_config={
+        'attn_implementation': "flash_attention_2"
+    }
+)
+```
+
+## Creating a Speaker for Voice Cloning
+
+To achieve the best results when creating a speaker profile, consider the following recommendations:
+
+1. **Audio Clip Duration:**
+   - Use an audio clip of around **10-15 seconds**.
+   - This duration provides sufficient data for the model to learn the speaker's characteristics while keeping the input manageable. The model's context length is 4096 tokens, allowing it to generate around 54 seconds of audio in total. However, when a speaker profile is included, this capacity is reduced proportionally to the length of the speaker's audio clip.
+
+2. **Audio Quality:**
+   - Ensure the audio is **clear and noise-free**. Background noise or distortions can reduce the model's ability to extract accurate voice features.
+
+3. **Accurate Transcription:**
+   - Provide a highly **accurate transcription** of the audio clip. Mismatches between the audio and transcription can lead to suboptimal results.
+
+4. **Speaker Familiarity:**
+   - The model performs best with voices that are similar to those seen during training. Using a voice that is **significantly different from typical training samples** (e.g., unique accents, rare vocal characteristics) might result in inaccurate replication.
+   - In such cases, you may need to **fine-tune the model** specifically on your target speaker's voice to achieve a better representation.
+
+5. **Parameter Adjustments:**
+   - Adjust parameters like `temperature` in the `generate` function to refine the expressive quality and consistency of the synthesized voice.
+
+## Model Specifications
+- **Base Model**: Qwen-2.5-0.5B
+- **Parameter Count**: 500M
+- **Language Support**:
+  - Primary: English
+  - Experimental: Chinese, Japanese, Korean
+- **License**: CC BY NC 4.0
+
+## Training Datasets
+- Emilia-Dataset (CC BY NC 4.0)
+- LibriTTS-R (CC BY 4.0)
+- Multilingual LibriSpeech (MLS) (CC BY 4.0)
+
+## Credits & References
+- [WavTokenizer](https://github.com/jishengpeng/WavTokenizer)
+- [CTC Forced Alignment](https://pytorch.org/audio/stable/tutorials/ctc_forced_alignment_api_tutorial.html)
+- [Qwen-2.5-0.5B](https://huggingface.co/Qwen/Qwen2.5-0.5B)
+- [OuteAI/OuteTTS-0.2-500M](https://huggingface.co/OuteAI/OuteTTS-0.2-500M)