Documentation
English · Norsk bokmål · Polski · 日本語 · 简体中文 · Español
The overview, documentation introductions and application are available in six interface languages. Detailed technical references currently remain in English; the website keeps your selected language and labels that fallback explicitly.
Start with the project quick start to run the CUDA container with external models.
Using YuE2
| Guide | Contents |
|---|---|
| Song examples | Listening gallery, original prompts, recipes and generation provenance |
| Docker runtime | Registry images, mounts, GPU selection, defaults and weight-free packaging |
| Models | Pinned downloads, optional components, provenance and conversion |
| Audio formats | FFmpeg uploads, Opus/MP3/FLAC/AAC exports and native WAV |
| Music and SDK APIs | Music endpoint, OpenAI-compatible clients, schema, quality and access |
| Queue and result storage | Shared backlog limits, retries, status, volume retention and load tests |
| Agent music tools | MCP connection, songwriting skill, restricted controls and one-hour audio links |
| LoRA adapters | Supported adapter files, placement and loading |
| Languages and localization | Studio locales, translated READMEs, gallery text and technical-reference fallback |
| API and engine reference | Request fields, job responses, CLI tools and engine internals |
Developing And Maintaining
| Guide | Contents |
|---|---|
| Development | Repository layout, local data migration, Task commands and native builds |
| Website | Themed README site, local preview, gallery integration and Pages deployment |
| Build dependencies | Reusable CUDA libraries, integrity checks and source rebuilds |
| Benchmarks | Resident-model speed/VRAM/lyric suite and historical long-song baseline |
| CI and releases | Tags, registry publication and Docker Hub overview maintenance |
| Docker Hub overview | Registry-ready product description with absolute links |
The engine reference also contains inherited upstream performance/parity results. The benchmark guide records this fork’s measured product baseline.
Application and dependency licenses are described in the root license and third-party notices.