SoulX-Singer / README.md
Xinsheng-Wang's picture
Upload README.md with huggingface_hub
9447616 verified
|
Raw
History Blame Contribute Delete
8.39 kB

A newer version of the Gradio SDK is available: 6.19.0

Upgrade
metadata
title: SoulX-Singer
emoji: ๐ŸŽค
sdk: gradio
sdk_version: 6.3.0
app_file: app.py
python_version: '3.10'
suggested_hardware: zero-a10g

๐ŸŽค SoulX-Singer

Official inference code for
SoulX-Singer: Towards High-Quality Zero-Shot Singing Voice Synthesis

SoulX-Logo

Demo Page HF-model Technical Report License


๐ŸŽต Overview

SoulX-Singer is a high-fidelity, zero-shot singing voice synthesis model that enables users to generate realistic singing voices for unseen singers.
It supports melody-conditioned (F0 contour) and score-conditioned (MIDI notes) control for precise pitch, rhythm, and expression.


โœจ Key Features

  • ๐ŸŽค Zero-Shot Singing โ€“ Generate high-fidelity voices for unseen singers, no fine-tuning needed.
  • ๐ŸŽต Flexible Control Modes โ€“ Melody (F0) and Score (MIDI) conditioning.
  • ๐Ÿ“š Large-Scale Dataset โ€“ 42,000+ hours of aligned vocals, lyrics, notes across Mandarin, English, Cantonese.
  • ๐Ÿง‘โ€๐ŸŽค Timbre Cloning โ€“ Preserve singer identity across languages, styles, and edited lyrics.
  • โœ๏ธ Singing Voice Editing โ€“ Modify lyrics while keeping natural prosody.
  • ๐ŸŒ Cross-Lingual Synthesis โ€“ High-fidelity synthesis by disentangling timbre from content.

Performance Radar


๐ŸŽฌ Demo Examples


๐Ÿ“ฐ News

  • [2026-02-06] SoulX-Singer inference code and models released.

๐Ÿš€ Quick Start

Note: This repo does not ship pretrained weights. SVS and preprocessing models must be downloaded from Hugging Face (see step 3).

1. Clone Repository

git clone https://github.com/Soul-AILab/SoulX-Singer.git
cd SoulX-Singer

2. Set Up Environment

1. Install Conda (if not already installed): https://docs.conda.io/en/latest/miniconda.html

2. Create and activate a Conda environment:

conda create -n soulxsinger -y python=3.10
conda activate soulxsinger

3. Install dependencies:

pip install -r requirements.txt

โš ๏ธ If you are in mainland China, use a PyPI mirror:

pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/ --trusted-host=mirrors.aliyun.com

3. Download Pretrained Models

This repository does not include pretrained models. You must download them from Hugging Face:

Install Hugging Face Hub and download:

pip install -U huggingface_hub

# SoulX-Singer SVS model
huggingface-cli download Soul-AILab/SoulX-Singer --local-dir pretrained_models/SoulX-Singer

# Preprocessing models (vocal separation, F0, ASR, etc.)
huggingface-cli download Soul-AILab/SoulX-Singer-Preprocess --local-dir pretrained_models/SoulX-Singer-Preprocess

4. Run the Demo

Run the inference demo:

bash example/infer.sh

This script relies on metadata generated from the preprocessing pipeline, including vocal separation and transcription. Users should follow the steps in preprocess to prepare the necessary metadata before running the demo with their own data.

โš ๏ธ Important Note The metadata produced by the automatic preprocessing pipeline may not perfectly align the singing audio with the corresponding lyrics and musical notes. For best synthesis quality, we strongly recommend manually correcting the alignment using the ๐ŸŽผ Midi-Editor.

How to use the Midi-Editor:

๐ŸŒ WebUI

You can launch the interactive interface with:

python webui.py

๐Ÿš€ Deploy as Hugging Face Space

This repo is ready to deploy as a Hugging Face Space. Pretrained models are not included; app.py downloads them from the Hub on first run.

๐Ÿ“– ่ฏฆ็ป†้ƒจ็ฝฒๆŒ‡ๅ—่ฏทๆŸฅ็œ‹๏ผšDEPLOY.md

ๅฟซ้€Ÿๆญฅ้ชค๏ผš

  1. ๅˆ›ๅปบ Space๏ผš่ฎฟ้—ฎ huggingface.co/spaces๏ผŒ็‚นๅ‡ป "Create new Space"๏ผŒ้€‰ๆ‹ฉ Gradio SDK
  2. ไธŠไผ ไปฃ็ ๏ผšไฝฟ็”จ Git ๆŽจ้€ๆˆ– Web ็•Œ้ขไธŠไผ ไปฃ็ ๆ–‡ไปถ
  3. ้…็ฝฎ็กฌไปถ๏ผšๅœจ Space Settings ไธญ้€‰ๆ‹ฉ GPU T4 Small๏ผˆๆŽจ่๏ผ‰ไปฅๅŠ ๅฟซๆŽจ็†้€Ÿๅบฆ
  4. ็ญ‰ๅพ…ๅฏๅŠจ๏ผšSpace ไผš่‡ชๅŠจๅฎ‰่ฃ…ไพ่ต–ใ€ไธ‹่ฝฝๆจกๅž‹ๅนถๅฏๅŠจๅบ”็”จ๏ผˆ้ฆ–ๆฌก่ฟ่กŒๅฏ่ƒฝ้œ€่ฆ 5-15 ๅˆ†้’Ÿ๏ผ‰

ๆจกๅž‹ไผš่‡ชๅŠจไปŽไปฅไธ‹ไป“ๅบ“ไธ‹่ฝฝ๏ผš

๐Ÿšง Roadmap

  • ๐Ÿ–ฅ๏ธ Web-based UI for easy and interactive inference
  • ๐ŸŒ Online demo deployment on Hugging Face Spaces
  • ๐Ÿ“Š Release the SoulX-Singer-Eval benchmark
  • ๐Ÿ“š Comprehensive tutorials and usage documentation

๐Ÿ™ Acknowledgements

Special thanks to the following open-source projects:

๐Ÿ“„ License

We use the Apache 2.0 license. Researchers and developers are free to use the codes and model weights of our SoulX-Singer. Check the license at LICENSE for more details.

โš ๏ธ Usage Disclaimer

SoulX-Singer is intended for academic research, educational purposes, and legitimate applications such as personalized singing synthesis and assistive technologies.

Please note:

  • ๐ŸŽค Respect intellectual property, privacy, and personal consent when generating singing content.
  • ๐Ÿšซ Do not use the model to impersonate individuals without authorization or to create deceptive audio.
  • โš ๏ธ The developers assume no liability for any misuse of this model.

We advocate for the responsible development and use of AI and encourage the community to uphold safety and ethical principles. For ethics or misuse concerns, please contact us.

๐Ÿ“ฌ Contact Us

We welcome your feedback, questions, and collaboration:


WeChat Group QR Code