Skip to content

Commit aa2ed8e

Browse files
authored
Update README.md (#1257)
1 parent 09fc351 commit aa2ed8e

File tree

1 file changed

+94
-54
lines changed

1 file changed

+94
-54
lines changed

README.md

Lines changed: 94 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,133 +1,172 @@
11
<div align="center">
22

33
<h1>Retrieval-based-Voice-Conversion-WebUI</h1>
4-
一个基于VITS的简单易用的语音转换(变声器)框架<br><br>
4+
An easy-to-use Voice Conversion framework based on VITS.<br><br>
55

66
[![madewithlove](https://img.shields.io/badge/made_with-%E2%9D%A4-red?style=for-the-badge&labelColor=orange
77
)](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI)
88

99
<img src="https://counter.seku.su/cmoe?name=rvc&theme=r34" /><br>
10-
10+
1111
[![Open In Colab](https://img.shields.io/badge/Colab-F9AB00?style=for-the-badge&logo=googlecolab&color=525252)](https://colab.research.google.com/github/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/blob/main/Retrieval_based_Voice_Conversion_WebUI.ipynb)
12-
[![Licence](https://img.shields.io/badge/LICENSE-MIT-green.svg?style=for-the-badge)](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/blob/main/LICENSE)
12+
[![Licence](https://img.shields.io/github/license/RVC-Project/Retrieval-based-Voice-Conversion-WebUI?style=for-the-badge)](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/blob/main/LICENSE)
1313
[![Huggingface](https://img.shields.io/badge/🤗%20-Spaces-yellow.svg?style=for-the-badge)](https://huggingface.co/lj1995/VoiceConversionWebUI/tree/main/)
1414

1515
[![Discord](https://img.shields.io/badge/RVC%20Developers-Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/HcsmBBGyVk)
1616

17-
[**更新日志**](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/blob/main/docs/Changelog_CN.md) | [**常见问题解答**](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98%E8%A7%A3%E7%AD%94) | [**AutoDL·5毛钱训练AI歌手**](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/wiki/Autodl%E8%AE%AD%E7%BB%83RVC%C2%B7AI%E6%AD%8C%E6%89%8B%E6%95%99%E7%A8%8B) | [**对照实验记录**](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/wiki/Autodl%E8%AE%AD%E7%BB%83RVC%C2%B7AI%E6%AD%8C%E6%89%8B%E6%95%99%E7%A8%8B](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/wiki/%E5%AF%B9%E7%85%A7%E5%AE%9E%E9%AA%8C%C2%B7%E5%AE%9E%E9%AA%8C%E8%AE%B0%E5%BD%95)) | [**在线演示**](https://huggingface.co/spaces/Ricecake123/RVC-demo)
18-
1917
</div>
2018

2119
------
20+
[**Changelog**](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/blob/main/docs/Changelog_EN.md) | [**FAQ (Frequently Asked Questions)**](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/wiki/FAQ-(Frequently-Asked-Questions))
21+
22+
[**English**](../en/README.en.md) | [**中文简体**](../../README.md) | [**日本語**](../jp/README.ja.md) | [**한국어**](../kr/README.ko.md) ([**韓國語**](../kr/README.ko.han.md)) | [**Türkçe**](../tr/README.tr.md)
23+
24+
25+
Check our [Demo Video](https://www.bilibili.com/video/BV1pm4y1z7Gm/) here!
2226

23-
[**English**](./docs/en/README.en.md) | [**中文简体**](./README.md) | [**日本語**](./docs/jp/README.ja.md) | [**한국어**](./docs/kr/README.ko.md) ([**韓國語**](./docs/kr/README.ko.han.md)) | [**Français**](./docs/fr/README.fr.md)| [**Türkçe**](./docs/tr/README.tr.md)
27+
Realtime Voice Conversion Software using RVC : [w-okada/voice-changer](https://github.com/w-okada/voice-changer)
2428

25-
点此查看我们的[演示视频](https://www.bilibili.com/video/BV1pm4y1z7Gm/) !
2629

27-
> 使用了RVC的实时语音转换: [w-okada/voice-changer](https://github.com/w-okada/voice-changer)
30+
> The dataset for the pre-training model uses nearly 50 hours of high quality VCTK open source dataset.
2831
29-
> 底模使用接近50小时的开源高质量VCTK训练集训练,无版权方面的顾虑,请大家放心使用
32+
> High quality licensed song datasets will be added to training-set one after another for your use, without worrying about copyright infringement.
3033
31-
> 请期待RVCv3的底模,参数更大,数据更大,效果更好,基本持平的推理速度,需要训练数据量更少。
34+
> 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.
3235
33-
## 简介
34-
本仓库具有以下特点
35-
+ 使用top1检索替换输入源特征为训练集特征来杜绝音色泄漏
36-
+ 即便在相对较差的显卡上也能快速训练
37-
+ 使用少量数据进行训练也能得到较好结果(推荐至少收集10分钟低底噪语音数据)
38-
+ 可以通过模型融合来改变音色(借助ckpt处理选项卡中的ckpt-merge)
39-
+ 简单易用的网页界面
40-
+ 可调用UVR5模型来快速分离人声和伴奏
41-
+ 使用最先进的[人声音高提取算法InterSpeech2023-RMVPE](#参考项目)根绝哑音问题。效果最好(显著地)但比crepe_full更快、资源占用更小
42-
+ A卡I卡加速支持
36+
## Summary
37+
This repository has the following features:
38+
+ Reduce tone leakage by replacing the source feature to training-set feature using top1 retrieval;
39+
+ Easy and fast training, even on relatively poor graphics cards;
40+
+ Training with a small amount of data also obtains relatively good results (>=10min low noise speech recommended);
41+
+ Supporting model fusion to change timbres (using ckpt processing tab->ckpt merge);
42+
+ Easy-to-use Webui interface;
43+
+ Use the UVR5 model to quickly separate vocals and instruments.
44+
+ Use the most powerful High-pitch Voice Extraction Algorithm [InterSpeech2023-RMVPE](#Credits) to prevent the muted sound problem. Provides the best results (significantly) and is faster, with even lower resource consumption than Crepe_full.
45+
+ AMD/Intel graphics cards acceleration supported.
46+
+ Intel ARC graphics cards acceleration with IPEX supported.
4347

44-
## 环境配置
45-
以下指令需在 Python 版本大于3.8的环境中执行。
48+
## Preparing the environment
49+
The following commands need to be executed in the environment of Python version 3.8 or higher.
4650

47-
(Windows/Linux)
48-
首先通过 pip 安装主要依赖:
51+
(Windows/Linux)
52+
First install the main dependencies through pip:
4953
```bash
50-
# 安装Pytorch及其核心依赖,若已安装则跳过
51-
# 参考自: https://pytorch.org/get-started/locally/
54+
# Install PyTorch-related core dependencies, skip if installed
55+
# Reference: https://pytorch.org/get-started/locally/
5256
pip install torch torchvision torchaudio
5357

54-
#如果是win系统+Nvidia Ampere架构(RTX30xx),根据 #21 的经验,需要指定pytorch对应的cuda版本
58+
#For Windows + Nvidia Ampere Architecture(RTX30xx), you need to specify the cuda version corresponding to pytorch according to the experience of https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/issues/21
5559
#pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu117
60+
61+
#For Linux + AMD Cards, you need to use the following pytorch versions:
62+
#pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/rocm5.4.2
5663
```
5764

58-
可以使用 poetry 来安装依赖:
65+
Then can use poetry to install the other dependencies:
5966
```bash
60-
# 安装 Poetry 依赖管理工具, 若已安装则跳过
61-
# 参考自: https://python-poetry.org/docs/#installation
67+
# Install the Poetry dependency management tool, skip if installed
68+
# Reference: https://python-poetry.org/docs/#installation
6269
curl -sSL https://install.python-poetry.org | python3 -
6370

64-
# 通过poetry安装依赖
71+
# Install the project dependencies
6572
poetry install
6673
```
6774

68-
你也可以通过 pip 来安装依赖:
75+
You can also use pip to install them:
6976
```bash
70-
N卡:
7177

72-
pip install -r requirements.txt
78+
for Nvidia graphics cards
79+
pip install -r requirements.txt
80+
81+
for AMD/Intel graphics cards on Windows (DirectML):
82+
pip install -r requirements-dml.txt
7383

74-
A卡/I卡:
75-
pip install -r requirements-dml.txt
84+
for Intel ARC graphics cards on Linux / WSL using Python 3.10:
85+
pip install -r requirements-ipex.txt
7686

87+
for AMD graphics cards on Linux (ROCm):
88+
pip install -r requirements-amd.txt
7789
```
7890

7991
------
80-
Mac 用户可以通过 `run.sh` 来安装依赖:
92+
Mac users can install dependencies via `run.sh`:
8193
```bash
8294
sh ./run.sh
8395
```
8496

85-
## 其他预模型准备
86-
RVC需要其他一些预模型来推理和训练。
97+
## Preparation of other Pre-models
98+
RVC requires other pre-models to infer and train.
8799

88-
你可以从我们的[Hugging Face space](https://huggingface.co/lj1995/VoiceConversionWebUI/tree/main/)下载到这些模型。
100+
You need to download them from our [Huggingface space](https://huggingface.co/lj1995/VoiceConversionWebUI/tree/main/).
89101

90-
以下是一份清单,包括了所有RVC所需的预模型和其他文件的名称:
102+
Here's a list of Pre-models and other files that RVC needs:
91103
```bash
92104
./assets/hubert/hubert_base.pt
93105

94106
./assets/pretrained
95107

96108
./assets/uvr5_weights
97109

98-
想测试v2版本模型的话,需要额外下载
110+
Additional downloads are required if you want to test the v2 version of the model.
99111

100112
./assets/pretrained_v2
101113

102-
如果你正在使用Windows,则你可能需要这个文件,若ffmpeg和ffprobe已安装则跳过; ubuntu/debian 用户可以通过apt install ffmpeg来安装这2个库, Mac 用户则可以通过brew install ffmpeg来安装 (需要预先安装brew)
114+
If you want to test the v2 version model (the v2 version model has changed the input from the 256 dimensional feature of 9-layer Hubert+final_proj to the 768 dimensional feature of 12-layer Hubert, and has added 3 period discriminators), you will need to download additional features
115+
116+
./assets/pretrained_v2
103117

104-
./ffmpeg
118+
#If you are using Windows, you may also need these two files, skip if FFmpeg and FFprobe are installed
119+
ffmpeg.exe
105120

106121
https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/ffmpeg.exe
107122

108-
./ffprobe
123+
ffprobe.exe
109124

110125
https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/ffprobe.exe
111126

112-
如果你想使用最新的RMVPE人声音高提取算法,则你需要下载音高提取模型参数并放置于RVC根目录
127+
If you want to use the latest SOTA RMVPE vocal pitch extraction algorithm, you need to download the RMVPE weights and place them in the RVC root directory
113128

114129
https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/rmvpe.pt
115130

116-
A卡I卡用户需要的dml环境要请下载
131+
For AMD/Intel graphics cards users you need download:
117132

118133
https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/rmvpe.onnx
119134

120135
```
121-
之后使用以下指令来启动WebUI:
136+
137+
Intel ARC graphics cards users needs to run `source /opt/intel/oneapi/setvars.sh` command before starting Webui.
138+
139+
Then use this command to start Webui:
122140
```bash
123141
python infer-web.py
124142
```
125143
126-
如果你正在使用Windows 或 macOS,你可以直接下载并解压`RVC-beta.7z`,前者可以运行`go-web.bat`以启动WebUI,后者则运行命令`sh ./run.sh`以启动WebUI。
127-
128-
仓库内还有一份`小白简易教程.doc`以供参考。
144+
If you are using Windows or macOS, you can download and extract `RVC-beta.7z` to use RVC directly by using `go-web.bat` on windows or `sh ./run.sh` on macOS to start Webui.
145+
146+
## ROCm Support for AMD graphic cards (Linux only)
147+
To use ROCm on Linux install all required drivers as described [here](https://rocm.docs.amd.com/en/latest/deploy/linux/os-native/install.html).
148+
149+
On Arch use pacman to install the driver:
150+
````
151+
pacman -S rocm-hip-sdk rocm-opencl-sdk
152+
````
153+
154+
You might also need to set these environment variables (e.g. on a RX6700XT):
155+
````
156+
export ROCM_PATH=/opt/rocm
157+
export HSA_OVERRIDE_GFX_VERSION=10.3.0
158+
````
159+
Also make sure your user is part of the `render` and `video` group:
160+
````
161+
sudo usermod -aG render $USERNAME
162+
sudo usermod -aG video $USERNAME
163+
````
164+
After that you can run the WebUI:
165+
```bash
166+
python infer-web.py
167+
```
129168
130-
## 参考项目
169+
## Credits
131170
+ [ContentVec](https://github.com/auspicious3000/contentvec/)
132171
+ [VITS](https://github.com/jaywalnut310/vits)
133172
+ [HIFIGAN](https://github.com/jik876/hifi-gan)
@@ -137,8 +176,9 @@ python infer-web.py
137176
+ [audio-slicer](https://github.com/openvpi/audio-slicer)
138177
+ [Vocal pitch extraction:RMVPE](https://github.com/Dream-High/RMVPE)
139178
+ The pretrained model is trained and tested by [yxlllc](https://github.com/yxlllc/RMVPE) and [RVC-Boss](https://github.com/RVC-Boss).
140-
141-
## 感谢所有贡献者作出的努力
179+
180+
## Thanks to all contributors for their efforts
142181
<a href="https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/graphs/contributors" target="_blank">
143182
<img src="https://contrib.rocks/image?repo=RVC-Project/Retrieval-based-Voice-Conversion-WebUI" />
144183
</a>
184+

0 commit comments

Comments
 (0)