mirror of
https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI.git
synced 2026-08-29 10:09:32 +02:00
132126af72
Add the five-model MSST backend, CUDA precision reuse, fast MP3/M4A encoding, PyAV compatibility fixes, remote dependencies, model configs, Hugging Face download guidance, and multilingual pymss credits. Remove the obsolete tools/uvr5 implementation.
233 lines
9.1 KiB
Markdown
233 lines
9.1 KiB
Markdown
<div align="center">
|
|
|
|
<h1>Retrieval-based-Voice-Conversion-WebUI</h1>
|
|
A simple, easy-to-use voice timbre conversion / voice changer framework.<br><br>
|
|
|
|
[](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI)
|
|
|
|
<img src="https://counter.seku.su/cmoe?name=rvc&theme=r34" /><br>
|
|
|
|
[](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/blob/main/LICENSE)
|
|
[](https://huggingface.co/lj1995/VoiceConversionWebUI/tree/main/)
|
|
|
|
|
|
[**Changelog**](./Changelog_EN.md) | [**FAQ (Frequently Asked Questions)**](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/wiki/FAQ-(Frequently-Asked-Questions))
|
|
|
|
[**English**](../en/README.en.md) | [**中文简体**](../../README.md) | [**日本語**](../jp/README.ja.md) | [**한국어**](../kr/README.ko.md) ([**韓國語**](../kr/README.ko.han.md)) | [**Français**](../fr/README.fr.md) | [**Türkçe**](../tr/README.tr.md) | [**Português**](../pt/README.pt.md)
|
|
|
|
</div>
|
|
|
|
> Check out our [Demo Video](https://www.bilibili.com/video/BV1pm4y1z7Gm/) here!
|
|
|
|
<table>
|
|
<tr>
|
|
<td align="center">Training and inference Webui</td>
|
|
<td align="center">Real-time voice changing GUI</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><img src="https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/assets/129054828/092e5c12-0d49-4168-a590-0b0ef6a4f630"></td>
|
|
<td align="center"><img src="https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/assets/129054828/730b4114-8805-44a1-ab1a-04668f3c30a6"></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">go-webui.bat</td>
|
|
<td align="center">go-realtime_gui.bat</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">You can freely choose the action you want to perform.</td>
|
|
<td align="center">We have achieved an end-to-end latency of 170ms. With the use of ASIO input and output devices, we have managed to achieve an end-to-end latency of 90ms, but it is highly dependent on hardware driver support.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
> The dataset for the pre-training model uses nearly 50 hours of high quality audio from the VCTK open source dataset.
|
|
|
|
> High quality licensed song datasets will be added to the training-set often for your use, without having to worry about copyright infringement.
|
|
|
|
> Please look forward to the pretrained base model of RVCv3, which has larger parameters, more training data, better results, unchanged inference speed, and requires less training data for training.
|
|
|
|
## Features:
|
|
+ Reduce tone leakage by replacing the source feature to training-set feature using top1 retrieval;
|
|
+ Easy + fast training, even on poor graphics cards;
|
|
+ Training with a small amounts of data (>=10min low noise speech recommended);
|
|
+ Model fusion to change timbres (using ckpt processing tab->ckpt merge);
|
|
+ Easy-to-use WebUI;
|
|
+ pymss/MSST model to quickly separate vocals and instruments;
|
|
+ High-pitch Voice Extraction Algorithm [InterSpeech2023-RMVPE](#Credits) to prevent a muted sound problem. Provides the best results (significantly) and is faster with lower resource consumption than Crepe_full;
|
|
+ AMD/Intel systems use the CPU dependency set; Windows may use DirectML and Linux uses CPU;
|
|
|
|
## Environment setup
|
|
|
|
This branch targets **Python 3.12 x64**. Run every command from the repository root. Ubuntu 24.04 x86_64 is recommended.
|
|
|
|
### Ubuntu 24.04
|
|
|
|
```bash
|
|
sudo apt update
|
|
sudo apt install -y python3.12 python3.12-venv python3.12-dev ffmpeg unzip libsndfile1 libportaudio2
|
|
|
|
python3.12 -m venv .venv
|
|
source .venv/bin/activate
|
|
python -m pip install --upgrade pip setuptools wheel
|
|
```
|
|
|
|
### Windows
|
|
|
|
Install Python 3.12 x64, then create a virtual environment:
|
|
|
|
```powershell
|
|
py -3.12 -m venv .venv
|
|
.venv\Scripts\activate
|
|
python -m pip install --upgrade pip setuptools wheel
|
|
```
|
|
|
|
### Choose dependencies by hardware
|
|
|
|
| Hardware | Installation |
|
|
| --- | --- |
|
|
| CPU, AMD, Intel | Use `requirments_cpu_py312.txt`; Windows may use DirectML, while Linux uses CPU |
|
|
| NVIDIA RTX 50 series | Install the CUDA 12.8 Torch pair first, then `requirments_cu128_py312.txt` |
|
|
| NVIDIA GPUs before the RTX 50 series | Install the CUDA 11.8 Torch pair first, then `requirments_cu118_py312.txt` |
|
|
|
|
#### CPU, AMD, Intel
|
|
|
|
```bash
|
|
python -m pip install -r requirments_cpu_py312.txt
|
|
```
|
|
|
|
#### NVIDIA RTX 50 series: two stages
|
|
|
|
```bash
|
|
python -m pip install torch==2.7.1+cu128 torchaudio==2.7.1+cu128 \
|
|
--index-url https://download.pytorch.org/whl/cu128 \
|
|
--extra-index-url https://pypi.org/simple
|
|
python -m pip install -r requirments_cu128_py312.txt
|
|
```
|
|
|
|
#### NVIDIA GPUs before the RTX 50 series: two stages
|
|
|
|
```bash
|
|
python -m pip install torch==2.7.1+cu118 torchaudio==2.7.1+cu118 \
|
|
--index-url https://download.pytorch.org/whl/cu118 \
|
|
--extra-index-url https://pypi.org/simple
|
|
python -m pip install -r requirments_cu118_py312.txt
|
|
```
|
|
|
|
Verify Torch and CUDA:
|
|
|
|
```bash
|
|
python -c "import torch; print('torch:', torch.__version__); print('cuda:', torch.version.cuda); print('cuda available:', torch.cuda.is_available())"
|
|
```
|
|
|
|
|
|
### Package indexes
|
|
|
|
The three `requirments_*.txt` files define their package indexes at the top. Keep the default mirrors in mainland China. To use official indexes, replace only `--index-url` and `--extra-index-url`; keep package versions, CUDA suffixes, and the two-stage order unchanged.
|
|
|
|
| Default mirror | Official source |
|
|
| --- | --- |
|
|
| `https://mirrors.pku.edu.cn/pypi/simple` | `https://pypi.org/simple` |
|
|
| `https://mirrors.nju.edu.cn/pytorch/whl/cpu` | `https://download.pytorch.org/whl/cpu` |
|
|
| `https://mirrors.nju.edu.cn/pytorch/whl/cu118` | `https://download.pytorch.org/whl/cu118` |
|
|
| `https://mirrors.nju.edu.cn/pytorch/whl/cu128` | `https://download.pytorch.org/whl/cu128` |
|
|
|
|
## Models and runtime directories
|
|
|
|
The WebUI creates runtime directories automatically. Download models from the [Hugging Face model repository](https://huggingface.co/lj1995/VoiceConversionWebUI/tree/main) and keep this layout:
|
|
|
|
```text
|
|
assets/
|
|
├── hubert_base/
|
|
│ ├── config.json
|
|
│ ├── preprocessor_config.json
|
|
│ └── pytorch_model.bin
|
|
├── rmvpe/rmvpe.pt
|
|
├── pretrained/
|
|
├── pretrained_v2/
|
|
├── pymss_weights/
|
|
├── weights/ # user RVC .pth models
|
|
└── indices/ # user .index files
|
|
logs/
|
|
└── mute/ # training silence samples
|
|
|
|
# Exact paths used by the code
|
|
assets/hubert_base/config.json
|
|
assets/hubert_base/preprocessor_config.json
|
|
assets/hubert_base/pytorch_model.bin
|
|
assets/rmvpe/rmvpe.pt
|
|
assets/pretrained/*.pth
|
|
assets/pretrained_v2/*.pth
|
|
assets/pymss_weights/*
|
|
assets/weights/*.pth
|
|
assets/indices/*.index
|
|
logs/mute/*
|
|
```
|
|
|
|
### Download models
|
|
|
|
```bash
|
|
python -m pip install --upgrade huggingface_hub
|
|
|
|
# Required for inference and feature extraction
|
|
hf download lj1995/VoiceConversionWebUI --revision main \
|
|
--include "hubert_base/*" --local-dir assets
|
|
hf download lj1995/VoiceConversionWebUI rmvpe.pt --revision main \
|
|
--local-dir assets/rmvpe
|
|
|
|
# Required for v1/v2 training
|
|
hf download lj1995/VoiceConversionWebUI --revision main \
|
|
--include "pretrained/*" "pretrained_v2/*" --local-dir assets
|
|
hf download lj1995/VoiceConversionWebUI mute.zip --revision main \
|
|
--local-dir .model-downloads
|
|
python -m zipfile -e .model-downloads/mute.zip logs
|
|
|
|
# Required only for pymss/MSST vocal separation
|
|
hf download lj1995/VoiceConversionWebUI --revision main \
|
|
--include "pymss_weights/*" --local-dir assets
|
|
```
|
|
|
|
Windows AMD/Intel DirectML environments additionally need:
|
|
|
|
```bash
|
|
hf download lj1995/VoiceConversionWebUI rmvpe.onnx --revision main \
|
|
--local-dir assets/rmvpe
|
|
```
|
|
|
|
|
|
### FFmpeg
|
|
|
|
The Ubuntu setup command above installs FFmpeg. On Windows, place these files in the repository root:
|
|
|
|
- [ffmpeg.exe](https://huggingface.co/lj1995/VoiceConversionWebUI/resolve/main/ffmpeg.exe?download=true)
|
|
- [ffprobe.exe](https://huggingface.co/lj1995/VoiceConversionWebUI/resolve/main/ffprobe.exe?download=true)
|
|
|
|
## Start the WebUI
|
|
|
|
```bash
|
|
python webui.py
|
|
```
|
|
|
|
For a headless Ubuntu server:
|
|
|
|
```bash
|
|
python webui.py --noautoopen
|
|
```
|
|
|
|
The default port is `7865`. Put personal `.pth` models in `assets/weights/` and `.index` files in `assets/indices/`.
|
|
|
|
## Credits
|
|
+ [ContentVec](https://github.com/auspicious3000/contentvec/)
|
|
+ [VITS](https://github.com/jaywalnut310/vits)
|
|
+ [HIFIGAN](https://github.com/jik876/hifi-gan)
|
|
+ [Gradio](https://github.com/gradio-app/gradio)
|
|
+ [FFmpeg](https://github.com/FFmpeg/FFmpeg)
|
|
+ [Ultimate Vocal Remover](https://github.com/Anjok07/ultimatevocalremovergui)
|
|
+ [pymss-project/pymss](https://github.com/pymss-project/pymss)
|
|
+ [audio-slicer](https://github.com/openvpi/audio-slicer)
|
|
+ [Vocal pitch extraction:RMVPE](https://github.com/Dream-High/RMVPE)
|
|
+ The pretrained model is trained and tested by [yxlllc](https://github.com/yxlllc/RMVPE) and [RVC-Boss](https://github.com/RVC-Boss).
|
|
|
|
## Thanks to all contributors for their efforts
|
|
<a href="https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/graphs/contributors" target="_blank">
|
|
<img src="https://contrib.rocks/image?repo=RVC-Project/Retrieval-based-Voice-Conversion-WebUI" />
|
|
</a>
|