SKILL.md
ACE-Step Documentation
Documentation skill for ACE-Step music generation system.
Quick Reference
Getting Started
| Document | Description |
|---|---|
| [README.md](getting-started/README.md) | Installation, model download, startup commands |
| [Tutorial.md](getting-started/Tutorial.md) | Getting started tutorial, best practices |
| [ABOUT.md](getting-started/ABOUT.md) | Project overview, architecture, model zoo |
Guides
| Document | Description |
|---|---|
| [GRADIOGUIDE.md](guides/GRADIOGUIDE.md) | Web UI usage guide |
| [INFERENCE.md](guides/INFERENCE.md) | Inference parameters tuning |
| [GPUCOMPATIBILITY.md](guides/GPUCOMPATIBILITY.md) | GPU/VRAM configuration, hardware recommendations |
| [ENVIRONMENTSETUP.md](guides/ENVIRONMENTSETUP.md) | Environment detection, uv installation, python_embeded setup (Windows/Linux/macOS) |
| [SCRIPTCONFIGURATION.md](guides/SCRIPTCONFIGURATION.md) | Configuring launch scripts: .bat (Windows) and .sh (Linux/macOS) |
| [UPDATEANDBACKUP.md](guides/UPDATEANDBACKUP.md) | Git updates, file backup, conflict resolution (all platforms) |
API (for developers)
| Document | Description |
|---|---|
| [API.md](api/API.md) | REST API documentation |
| [OpenrouterAPI.md](api/OpenrouterAPI.md) | OpenRouter API integration |
Instructions
- Installation questions → read [getting-started/README.md](getting-started/README.md)
- General usage / best practices → read [getting-started/Tutorial.md](getting-started/Tutorial.md)
- Project overview / architecture → read [getting-started/ABOUT.md](getting-started/ABOUT.md)
- Web UI questions → read [guides/GRADIOGUIDE.md](guides/GRADIOGUIDE.md)
- Inference parameter tuning → read [guides/INFERENCE.md](guides/INFERENCE.md)
- GPU/VRAM issues → read [guides/GPUCOMPATIBILITY.md](guides/GPUCOMPATIBILITY.md)
- Environment setup (uv, pythonembeded) → read [guides/ENVIRONMENTSETUP.md](guides/ENVIRONMENT_SETUP.md)
- Launch script configuration (.bat/.sh) → read [guides/SCRIPTCONFIGURATION.md](guides/SCRIPTCONFIGURATION.md)
- Updates and backup → read [guides/UPDATEANDBACKUP.md](guides/UPDATEANDBACKUP.md)
- API development → read [api/API.md](api/API.md) or [api/OpenrouterAPI.md](api/OpenrouterAPI.md)
Common Issues
- Installation problems: See getting-started/README.md
- VRAM insufficient: See guides/GPU_COMPATIBILITY.md
- Model download failed: See getting-started/README.md or guides/SCRIPT_CONFIGURATION.md
- uv not found: See guides/ENVIRONMENT_SETUP.md
- Environment detection issues: See guides/ENVIRONMENT_SETUP.md
- BAT/SH script configuration: See guides/SCRIPT_CONFIGURATION.md
- Update and backup: See guides/UPDATEANDBACKUP.md
- Update conflicts: See guides/UPDATEANDBACKUP.md
- Inference quality issues: See guides/INFERENCE.md
- Gradio UI not starting: See guides/GRADIO_GUIDE.md