ai-agent-book/chapter8/orpheus/README.md

# Orpheus TTS - Text-to-Speech Fine-tuning with Unsloth

## English

This project demonstrates how to fine-tune the Orpheus 3B text-to-speech model using Unsloth for efficient training and inference.

## Overview

Orpheus is a text-to-speech (TTS) model that converts text into natural-sounding speech. This implementation uses:
- **Unsloth** for efficient LoRA fine-tuning (30% less VRAM, 2x larger batch sizes)
- **SNAC** (Stochastic Neural Audio Codec) for audio tokenization at 24kHz
- **Hugging Face Transformers** for model training and inference

## Features

- ✅ Fine-tune Orpheus 3B model with minimal GPU memory
- ✅ Support for single-speaker and multi-speaker TTS
- ✅ **Expressive speech with emotion tags** (laugh, sigh, gasp, etc.)
- ✅ Audio generation with customizable parameters
- ✅ Automatic WAV file export of generated speech
- ✅ LoRA adapter training for efficient fine-tuning

## Installation

### Prerequisites
- Python 3.10+
- CUDA-compatible GPU (recommended: 16GB+ VRAM)
- CUDA toolkit installed

### Install Dependencies

**IMPORTANT**: The `datasets` package version must be between 3.4.1 and 4.0.0 for compatibility.

```bash
# From the repository root: use a separate project-local environment for Orpheus.
# Its audio stack needs a torch/torchaudio pair matched to your CUDA platform,
# so do not install it into the shared root .venv.
cd chapter8/orpheus
python -m venv .venv-orpheus
source .venv-orpheus/bin/activate
# Windows PowerShell: .\.venv-orpheus\Scripts\Activate.ps1
# Windows cmd: .venv-orpheus\Scripts\activate.bat

python -m pip install --upgrade pip
python -m pip install -r requirements.txt
```

For Colab or specific environments, you may need:
```bash
pip install --no-deps bitsandbytes accelerate xformers peft trl triton cut_cross_entropy unsloth_zoo
pip install --no-deps unsloth
```

## Project Structure

```
orpheus/
├── orpheus_sft_unsloth.py    # Full training + inference script
├── inference.py               # Standalone inference script
├── requirements.txt           # Python dependencies
├── README.md                  # This file
├── lora_model/               # Saved LoRA adapters (after training)
└── generated_audio/          # Generated audio outputs
```

## Usage

### Training

Fine-tune the model on your dataset:

```bash
python orpheus_sft_unsloth.py
```

The training script will:
1. Load the pre-trained Orpheus 3B model
2. Apply LoRA adapters for efficient fine-tuning
3. Train on the public Elise mirror (or your custom dataset)
4. Save the fine-tuned LoRA adapters to `lora_model/`

**Training Parameters:**
- Batch size: 1 per device
- Gradient accumulation: 4 steps
- Learning rate: 2e-4
- Training steps: 60 (configurable)
- LoRA rank: 64

### Inference

Generate speech from text using the fine-tuned model:

```bash
python inference.py
```

Or use it as a module:

```python
from inference import OrpheusInference

# Initialize the model
tts = OrpheusInference(
    model_path="unsloth/orpheus-3b-0.1-ft",
    lora_path="lora_model"  # Optional: load fine-tuned adapters
)

# Generate speech with emotion tags
prompts = [
    "Hey there my name is Elise, <giggles> and I'm a speech generation model.",
    "I missed you <laugh> so much! It's been way too long.",
    "This is absolutely amazing <gasp> I can't believe it worked!"
]

audio_files = tts.generate(
    prompts=prompts,
    output_dir="generated_audio",
    temperature=0.6,
    top_p=0.95,
    max_new_tokens=1200
)

print(f"Generated {len(audio_files)} audio files")
```

### Emotion Tags (Expressive Speech)

Orpheus supports special emotion/expression tags to create more expressive and natural-sounding speech:

**Supported Tags:**
- **Laughter**: `<laugh>`, `<giggles>`, `<chuckle>`
- **Emotions**: `<sigh>`, `<gasp>`
- **Physical sounds**: `<yawn>`, `<cough>`, `<sniffle>`, `<groan>`

**Usage:**
```python
prompts = [
    "Hey there <giggles> welcome to my channel!",
    "I missed you <laugh> so much!",
    "That's so beautiful <sigh> it brings back memories.",
    "I'm so tired <yawn> after working all day.",
    "This is incredible <gasp> I can't believe my eyes!"
]

audio_files = tts.generate(prompts=prompts)
```

**How it works:**
- Tags are enclosed in angle brackets: `<tag>`
- During training, the model learns to associate these tags with audio patterns
- The Elise dataset contains 336 occurrences of "laughs", 156 of "sighs", etc.
- If your custom dataset lacks these tags, you can manually annotate transcripts where the audio contains those expressions

### Multi-Speaker Support

For multi-speaker models, specify the voice name:

```python
tts.generate(
    prompts=["This is a test <laugh> with emotion."],
    voice="speaker_name"  # Specify the speaker
)
```

## Dataset Format

The training script expects datasets with the following structure:

**Single-speaker:**
- `text`: The text to be spoken
- `audio`: Audio file with `array` and `sampling_rate` fields

**Multi-speaker:**
- `source`: Speaker identifier
- `text`: The text to be spoken
- `audio`: Audio file with `array` and `sampling_rate` fields

Example dataset: [maxbsoft/mrdragonfox-elise](https://huggingface.co/datasets/maxbsoft/mrdragonfox-elise). The original `MrDragonFox/Elise` repository named by the notebook is now disabled.

## Model Architecture

### Audio Tokenization (SNAC)
- Sample rate: 24kHz
- Multi-layer hierarchical codec (3 layers)
- 7 tokens per frame (1 + 2 + 4 from the three layers)
- Duplicate frame removal for efficiency

### Special Tokens
- Start of human: 128259
- End of human: 128260
- Start of AI: 128261
- End of AI: 128262
- Start of speech: 128257
- End of speech: 128258
- Pad token: 128263

## Output

Generated audio files are saved as WAV files in the `generated_audio/` directory:
- Format: WAV (PCM)
- Sample rate: 24kHz
- Naming: `output_0.wav`, `output_1.wav`, etc.

## Memory Usage

Typical memory requirements:
- Training: ~12-16GB VRAM (with LoRA and 4-bit quantization)
- Inference: ~8-10GB VRAM
- CPU RAM: ~16GB recommended

## Troubleshooting

### Common Issues

**1. Dataset version error:**
```
Ensure datasets>=3.4.1,<4.0.0 is installed
pip install "datasets>=3.4.1,<4.0.0" --force-reinstall
```

**2. CUDA out of memory:**
- Reduce `max_new_tokens` during inference
- Use `load_in_4bit=True` when loading the model
- Reduce batch size or enable gradient checkpointing

**3. Multi-GPU issues:**
- Set `CUDA_VISIBLE_DEVICES=0` to use only one GPU
- `per_device_train_batch_size >1` may cause errors on multi-GPU setups

## Performance Tips

1. **Faster Inference**: Use `FastLanguageModel.for_inference(model)` before generation
2. **Memory Optimization**: Enable 4-bit quantization with `load_in_4bit=True`
3. **Better Quality**: Adjust `temperature` (0.4-0.8) and `top_p` (0.9-0.95) parameters
4. **Longer Audio**: Increase `max_new_tokens` (each ~7 tokens = 1 audio frame)

## Resources

- [Unsloth Documentation](https://docs.unsloth.ai/)
- [Unsloth TTS Guide](https://docs.unsloth.ai/basics/text-to-speech-tts-fine-tuning)
- [SNAC Model](https://huggingface.co/hubertsiuzdak/snac_24khz)
- [Orpheus Model](https://huggingface.co/unsloth/orpheus-3b-0.1-ft)
- [Discord Support](https://discord.gg/unsloth)

## License

This project uses models and libraries with their respective licenses:
- Unsloth: Apache 2.0
- Transformers: Apache 2.0
- Orpheus model: Check model card on Hugging Face

## Citation

If you use this code in your research, please cite:

```bibtex
@misc{orpheus-tts-unsloth,
  title={Orpheus TTS Fine-tuning with Unsloth},
  author={Unsloth AI Team},
  year={2024},
  url={https://github.com/unslothai/unsloth}
}
```

## Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

## Acknowledgments

- Thanks to [Etherl](https://huggingface.co/Etherll) for creating the original notebook
- Unsloth AI team for the efficient training framework
- Hugging Face for hosting models and datasets

---

## 中文

# Orpheus TTS：使用 Unsloth 微调文本转语音模型

## 概述

本项目演示如何使用 Unsloth 对 Orpheus TTS 模型进行高效微调，并提供训练、推理、情感标签和多说话人支持示例。

## 功能

- 使用 LoRA/QLoRA 进行显存友好的微调
- 支持情感标签与富表现力语音
- 支持多说话人数据与推理
- 使用 SNAC 音频离散编码
- 提供训练和推理脚本

## 安装

需要支持 CUDA 的 GPU、Python 3.10+、PyTorch、FFmpeg，以及与本机 CUDA 环境匹配的 Unsloth 依赖。

```bash
# 从仓库根目录开始：Orpheus 请使用单独的项目本地环境。
# 它的音频栈需要与本机 CUDA 平台匹配的 torch/torchaudio 组合，
# 因此不要安装到共享的根目录 .venv 中。
cd chapter8/orpheus
python -m venv .venv-orpheus
source .venv-orpheus/bin/activate
# Windows PowerShell：.\.venv-orpheus\Scripts\Activate.ps1
# Windows cmd：.venv-orpheus\Scripts\activate.bat

python -m pip install --upgrade pip
python -m pip install -r requirements.txt
```

## 项目结构

训练脚本负责加载数据集、模型与 LoRA 配置并保存适配器；推理脚本加载基础模型和适配器，将生成的音频 token 通过 SNAC 解码为音频文件。

## 使用

### 训练

按脚本中的模型、数据集、批量大小、学习率和输出目录配置启动训练。显存不足时可减小批量大小、启用梯度累积或使用量化加载。

### 推理

加载训练后的适配器，输入文本后生成语音。文本中可加入模型支持的情感标签，以控制笑声、叹气等表达。

### 情感标签

Orpheus 支持在文本中嵌入特定标签来生成更有表现力的语音。实际可用标签取决于基础模型和训练数据。

### 多说话人支持

数据样本应包含稳定的说话人标识。推理时使用与训练一致的说话人 token，避免音色混淆。

## 数据集格式

数据集需要提供文本与音频字段，并可选择包含说话人信息。音频应使用一致的采样率和声道格式；训练前应过滤损坏或异常长度的样本。

## 模型架构

模型将文本 token 与 SNAC 音频 token 放在统一序列中进行自回归建模。特殊 token 用于标记文本、说话人、音频起止位置和生成边界。

## 输出

训练输出包含 LoRA 适配器、分词器和训练状态；推理输出为解码后的音频文件。

## 显存占用

显存需求取决于模型大小、序列长度、批量大小和量化方式。遇到显存不足时，应优先降低批量大小和最大序列长度。

## 故障排查

常见问题包括 CUDA/Flash Attention 版本不兼容、FFmpeg 缺失、音频格式错误、特殊 token 不匹配以及生成长度不足。

## 性能建议

使用混合精度、梯度检查点和批量预处理；在正式训练前先用少量样本完成端到端冒烟测试。

## 资源、许可与引用

模型、Unsloth、SNAC 和数据集的链接见英文部分。使用本项目时请分别遵守上游模型、代码和数据许可，并按上游要求引用。

## 贡献与致谢

欢迎通过 Issue 和 Pull Request 改进脚本与文档。感谢 Orpheus、Unsloth、SNAC 及其开源社区。