GPT-SoVITS/docs/cn

GPT-SoVITS-WebUI

强大的少样本语音转换与语音合成Web用户界面。

English | 中文简体 | 日本語 | 한국어

---

功能：

1. 零样本文本到语音（TTS）： 输入 5 秒的声音样本，即刻体验文本到语音转换。

2. 少样本 TTS： 仅需 1 分钟的训练数据即可微调模型，提升声音相似度和真实感。

3. 跨语言支持： 支持与训练数据集不同语言的推理，目前支持英语、日语和中文。

4. WebUI 工具： 集成工具包括声音伴奏分离、自动训练集分割、中文自动语音识别(ASR)和文本标注，协助初学者创建训练数据集和 GPT/SoVITS 模型。

查看我们的介绍视频 demo video

未见过的说话者 few-shot 微调演示：

https://github.com/RVC-Boss/GPT-SoVITS/assets/129054828/05bee1fa-bdd8-4d85-9350-80c060ab47fb

用户手册: 简体中文 | English

安装

中国地区用户可点击此处使用 AutoDL 云端镜像进行体验。

测试通过的环境

• Python 3.9，PyTorch 2.0.1，CUDA 11
• Python 3.10.13，PyTorch 2.1.2，CUDA 12.3
• Python 3.9，Pytorch 2.2.2，macOS 14.4.1（Apple 芯片）
• Python 3.9，PyTorch 2.2.2，CPU 设备

注: numba==0.56.4 需要 python<3.11

Windows

如果你是 Windows 用户（已在 win>=10 上测试），可以直接下载预打包文件，解压后双击 go-webui.bat 即可启动 GPT-SoVITS-WebUI。

中国地区用户可以通过点击链接并选择“下载副本”来下载0217版本包或0306fix2版本包。

注：0306fix2版本推理速度翻倍，节约生命。修复了无参考文本模式的所有问题。

Linux

conda create -n GPTSoVits python=3.9
conda activate GPTSoVits
bash install.sh

macOS

注：在 Mac 上使用 GPU 训练的模型效果显著低于其他设备训练的模型，所以我们暂时使用CPU进行训练。

1. 运行 xcode-select --install 安装 Xcode command-line tools。
2. 运行 brew install ffmpeg 或 conda install ffmpeg 安装 FFmpeg。
3. 完成上述步骤后，运行以下的命令来安装本项目：

conda create -n GPTSoVits python=3.9
conda activate GPTSoVits

pip install -r requirements.txt

手动安装

安装依赖

pip install -r requirements.txt

安装 FFmpeg

Conda 使用者

conda install ffmpeg

Ubuntu/Debian 使用者

sudo apt install ffmpeg
sudo apt install libsox-dev
conda install -c conda-forge 'ffmpeg<7'

Windows 使用者

下载并将 ffmpeg.exe 和 ffprobe.exe 放置在 GPT-SoVITS 根目录下。

在 Docker 中使用

docker-compose.yaml 设置

0. image 的标签：由于代码库更新很快，镜像的打包和测试又很慢，所以请自行在 Docker Hub 查看当前打包好的最新的镜像并根据自己的情况选用，或者在本地根据您自己的需求通过 Dockerfile 进行构建。
1. 环境变量：

• is_half: 半精度/双精度控制。在进行 "SSL extracting" 步骤时如果无法正确生成 4-cnhubert/5-wav32k 目录下的内容时，一般都是它引起的，可以根据实际情况来调整为 True 或者 False。

2. Volume 设置，容器内的应用根目录设置为 /workspace。 默认的 docker-compose.yaml 中列出了一些实际的例子，便于上传/下载内容。
3. shm_size：Windows 下的 Docker Desktop 默认可用内存过小，会导致运行异常，根据自己情况酌情设置。
4. deploy 小节下的 gpu 相关内容，请根据您的系统和实际情况酌情设置。

通过 docker compose 运行

docker compose -f "docker-compose.yaml" up -d

通过 docker 命令运行

同上，根据您自己的实际情况修改对应的参数，然后运行如下命令：

docker run --rm -it --gpus=all --env=is_half=False --volume=G:\GPT-SoVITS-DockerTest\output:/workspace/output --volume=G:\GPT-SoVITS-DockerTest\logs:/workspace/logs --volume=G:\GPT-SoVITS-DockerTest\SoVITS_weights:/workspace/SoVITS_weights --workdir=/workspace -p 9880:9880 -p 9871:9871 -p 9872:9872 -p 9873:9873 -p 9874:9874 --shm-size="16G" -d breakstring/gpt-sovits:xxxxx

预训练模型

从 GPT-SoVITS Models 下载预训练模型，并将它们放置在 GPT_SoVITS\pretrained_models 中。

对于 UVR5（人声/伴奏分离和混响移除，附加），从 UVR5 Weights 下载模型，并将它们放置在 tools/uvr5/uvr5_weights 中。

中国地区用户可以进入以下链接并点击“下载副本”下载以上两个模型：

• GPT-SoVITS Models

• UVR5 Weights

对于中文自动语音识别（附加），从 Damo ASR Model, Damo VAD Model, 和 Damo Punc Model 下载模型，并将它们放置在 tools/asr/models 中。

对于英语与日语自动语音识别（附加),从 Faster Whisper Large V3 下载模型，并将它们放置在 tools/asr/models 中。 此外，其他模型可能具有类似效果，但占用更小的磁盘空间。

中国地区用户可以通过以下链接下载：

• Faster Whisper Large V3(点击“下载副本”)

• Faster Whisper Large V3(Hugging Face镜像站)

数据集格式

文本到语音（TTS）注释 .list 文件格式：

vocal_path|speaker_name|language|text

语言字典：

• 'zh': Chinese
• 'ja': Japanese
• 'en': English

示例：

D:\GPT-SoVITS\xxx/xxx.wav|xxx|en|I like playing Genshin.

主分支 API 使用指南

 python api.py -dr "123.wav" -dt "一二三。" -dl "zh"

执行参数

必要参数:

• -s - SoVITS模型路径，可以在config.py中指定。
• -g - GPT模型路径，可以在config.py中指定。

调用请求缺少参考音频时使用:

• -dr - 默认参考音频路径，当请求中未提供参考音频时使用。
• -dt - 默认参考音频对应的文本。
• -dl - 默认参考音频的语言，选项包括"all_zh"、"en"、"all_ja","zh"、"ja"。

可选参数:

• -d - 推理设备，选项包括"cuda"、"cpu"。

• -a - 绑定地址，默认为"127.0.0.1"。

• -p - 绑定端口，默认为9880，可以在config.py中指定。

• -fp - 使用全精度覆盖config.py的设置。

• -hp - 使用半精度覆盖config.py的设置。

• -sm - 流式返回模式，默认不启用，选项包括"close"、"c"、"normal"、"n"、"keepalive"、"k"。

• -mt - 返回的音频编码格式，流式默认为ogg，非流式默认为wav，选项包括"wav"、"ogg"、"aac"。

• -cp - 文本切分符号设置，默认为空，以"，。？！"字符串的方式传入。

• -hb - cnhubert路径。

• -b - bert路径。

推理

端点: /

使用执行参数指定的参考音频和切分符号进行推理。可使用GET或POST方法：

GET： http://127.0.0.1:9880?text=先帝创业未半而中道崩殂，今天下三分，益州疲弊，此诚危急存亡之秋也。&text_language=zh

POST：

{
    "text": "先帝创业未半而中道崩殂，今天下三分，益州疲弊，此诚危急存亡之秋也。",
    "text_language": "zh"
}

使用执行参数指定的参考音频并设置分割符号。可使用GET或POST方法：

GET：

http://127.0.0.1:9880?text=先帝创业未半而中道崩殂，今天下三分，益州疲弊，此诚危急存亡之秋也。&text_language=zh&cut_punc=，。

POST：

{
    "text": "先帝创业未半而中道崩殂，今天下三分，益州疲弊，此诚危急存亡之秋也。",
    "text_language": "zh",
    "cut_punc": "，。"
}

手动指定当次推理所使用的参考音频。可使用GET或POST方法:

GET：

http://127.0.0.1:9880?refer_wav_path=123.wav&prompt_text=一二三。&prompt_language=zh&text=先帝创业未半而中道崩殂，今天下三分，益州疲弊，此诚危急存亡之秋也。&text_language=zh&cut_punc=，。

POST：

{
    "refer_wav_path": "三国杀.wav",
    "prompt_text": "这就是玩三国杀，带给我的自信。",
    "prompt_language": "zh",
    "text": "先帝创业未半而中道崩殂，今天下三分，益州疲弊，此诚危急存亡之秋也。",
    "text_language": "zh",
    "cut_punc": "，。"
}

成功时，直接返回wav音频流，HTTP状态码为200。失败时，返回包含错误信息的JSON，HTTP状态码为400。

更换默认参考音频

端点: /change_refer

手动更换所使用的默认参考音频。可使用GET或POST方法:

GET：

http://127.0.0.1:9880/change_refer?refer_wav_path=三国杀.wav&prompt_text=这就是玩三国杀，带给我的自信。&prompt_language=zh `

POST：

{
    "refer_wav_path": "三国杀.wav",
    "prompt_text": "这就是玩三国杀，带给我的自信。",
    "prompt_language": "zh"
}

成功时，返回JSON，HTTP状态码为200。失败时，返回JSON，HTTP状态码为400。

命令控制

端点: /control

命令包括："restart"（重新运行）和"exit"（结束运行）。可使用GET或POST方法：

GET：

http://127.0.0.1:9880/control?command=restart `

POST：

{
    "command": "restart"
}

待办事项清单

• 高优先级：

  • 日语和英语的本地化。
  • 用户指南。
  • 日语和英语数据集微调训练。

• Features:

  • 零样本声音转换（5 秒）/ 少样本声音转换（1 分钟）。
  • TTS 语速控制。
  • 增强的 TTS 情感控制。
  • 尝试将 SoVITS 令牌输入更改为词汇的概率分布。
  • 改进英语和日语文本前端。
  • 开发体积小和更大的 TTS 模型。
  • Colab 脚本。
  • 扩展训练数据集（从 2k 小时到 10k 小时）。
  • 更好的 sovits 基础模型（增强的音频质量）。
  • 模型混合。

（可选）命令行的操作方式

使用命令行打开UVR5的WebUI

python tools/uvr5/webui.py "<infer_device>" <is_half> <webui_port_uvr5>

如果打不开浏览器，请按照下面的格式进行UVR处理，这是使用mdxnet进行音频处理的方式

python mdxnet.py --model --input_root --output_vocal --output_ins --agg_level --format --device --is_half_precision 

这是使用命令行完成数据集的音频切分的方式

python audio_slicer.py \
    --input_path "<path_to_original_audio_file_or_directory>" \
    --output_root "<directory_where_subdivided_audio_clips_will_be_saved>" \
    --threshold <volume_threshold> \
    --min_length <minimum_duration_of_each_subclip> \
    --min_interval <shortest_time_gap_between_adjacent_subclips> 
    --hop_size <step_size_for_computing_volume_curve>

这是使用命令行完成数据集ASR处理的方式（仅限中文）

python tools/asr/funasr_asr.py -i <input> -o <output>

通过Faster_Whisper进行ASR处理（除中文之外的ASR标记）

（没有进度条，GPU性能可能会导致时间延迟）

python ./tools/asr/fasterwhisper_asr.py -i <input> -o <output> -l <language>

启用自定义列表保存路径

致谢

特别感谢以下项目和贡献者：

• ar-vits
• SoundStorm
• vits
• TransferTTS
• Chinese Speech Pretrain
• contentvec
• hifi-gan
• Chinese-Roberta-WWM-Ext-Large
• fish-speech
• ultimatevocalremovergui
• audio-slicer
• SubFix
• FFmpeg
• gradio

感谢所有贡献者的努力