Skip to content

Commit 0efe48c

Browse files
authored
docs: make english README the repository's default README (#38)
* docs: make english README the repository's default README some people might be scared off by a base README being in Chinese, so using a more universally known language like English seems to be more suited for open-source projects. i believe some people just come to the project, see the README and then they're frightened to even work on/with it this is a change curated by the #33 issue * docs: use MIT badge directly instead of relying on the repo link * docs: make READMEs grab the license badge directly via repo's specified license
1 parent 80b4723 commit 0efe48c

File tree

7 files changed

+298
-298
lines changed

7 files changed

+298
-298
lines changed

README.md

Lines changed: 77 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,113 @@
11
<div align="center">
22

33
# Retrieval-based-Voice-Conversion-WebUI
4-
一个基于VITS的简单易用的变声框架<br><br>
4+
An easy-to-use voice conversion framework based on VITS.
5+
6+
57

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

911
![moe](https://counter.seku.su/cmoe?name=rvc&theme=r34)
1012

11-
[![Licence](https://img.shields.io/badge/LICENSE-MIT-green.svg?style=for-the-badge)](https://github.com/fumiama/Retrieval-based-Voice-Conversion-WebUI/blob/main/LICENSE)
13+
[![Licence](https://img.shields.io/github/license/fumiama/Retrieval-based-Voice-Conversion-WebUI?style=for-the-badge)](https://github.com/fumiama/Retrieval-based-Voice-Conversion-WebUI/blob/main/LICENSE)
1214
[![Huggingface](https://img.shields.io/badge/🤗%20-Spaces-yellow.svg?style=for-the-badge)](https://huggingface.co/lj1995/VoiceConversionWebUI/tree/main/)
1315

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

16-
[**更新日志**](https://github.com/fumiama/Retrieval-based-Voice-Conversion-WebUI/blob/main/docs/Changelog_CN.md) | [**常见问题解答**](https://github.com/fumiama/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/fumiama/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/fumiama/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/fumiama/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://modelscope.cn/studios/FlowerCry/RVCv2demo)
18+
[**Changelog**](https://github.com/fumiama/Retrieval-based-Voice-Conversion-WebUI/blob/main/docs/Changelog_EN.md) | [**FAQ (Frequently Asked Questions)**](https://github.com/fumiama/Retrieval-based-Voice-Conversion-WebUI/wiki/FAQ-(Frequently-Asked-Questions))
1719

18-
[**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) | [**Português**](./docs/pt/README.pt.md)
20+
[**English**](./README.md) | [**中文简体**](./docs/cn/README.cn.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) | [**Português**](./docs/pt/README.pt.md)
1921

2022
</div>
2123

22-
> 底模使用接近50小时的开源高质量VCTK训练集训练,无版权方面的顾虑,请大家放心使用
24+
> The base model is trained using nearly 50 hours of high-quality open-source VCTK training set. Therefore, there are no copyright concerns, please feel free to use.
2325
24-
> 请期待RVCv3的底模,参数更大,数据集更大,效果更好,基本持平的推理速度,需要训练数据量更少。
26+
> Please look forward to the base model of RVCv3 with larger parameters, larger dataset, better effects, basically flat inference speed, and less training data required.
2527
26-
> 由于某些地区无法直连Hugging Face,即使设法成功访问,速度也十分缓慢,特推出模型/整合包/工具的一键下载器,欢迎试用:[RVC-Models-Downloader](https://github.com/fumiama/RVC-Models-Downloader)
28+
> There's a [one-click downloader](https://github.com/fumiama/RVC-Models-Downloader) for models/integration packages/tools. Welcome to try.
2729
28-
| 训练推理界面 | 实时变声界面 |
30+
| Training and inference Webui | Real-time voice changing GUI |
2931
| :--------: | :---------: |
3032
| ![web](https://github.com/fumiama/Retrieval-based-Voice-Conversion-WebUI/assets/129054828/092e5c12-0d49-4168-a590-0b0ef6a4f630) | ![realtime-gui](https://github.com/fumiama/Retrieval-based-Voice-Conversion-WebUI/assets/129054828/730b4114-8805-44a1-ab1a-04668f3c30a6) |
3133
| go-web.bat | go-realtime-gui.bat |
32-
| 可以自由选择想要执行的操作。 | 我们已经实现端到端170ms延迟。如使用ASIO输入输出设备,已能实现端到端90ms延迟,但非常依赖硬件驱动支持。|
34+
| You can freely choose the action you want to perform. | 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. |
3335

34-
## 简介
35-
本仓库具有以下特点
36-
+ 使用top1检索替换输入源特征为训练集特征来杜绝音色泄漏
37-
+ 即便在相对较差的显卡上也能快速训练
38-
+ 使用少量数据进行训练也能得到较好结果(推荐至少收集10分钟低底噪语音数据)
39-
+ 可以通过模型融合来改变音色(借助ckpt处理选项卡中的ckpt-merge)
40-
+ 简单易用的网页界面
41-
+ 可调用UVR5模型来快速分离人声和伴奏
42-
+ 使用最先进的[人声音高提取算法InterSpeech2023-RMVPE](#参考项目)根绝哑音问题,效果更好,运行更快,资源占用更少
43-
+ A卡I卡加速支持
36+
## Features:
37+
+ Reduce tone leakage by replacing the source feature to training-set feature using top1 retrieval;
38+
+ Easy + fast training, even on poor graphics cards;
39+
+ Training with a small amounts of data (>=10min low noise speech recommended);
40+
+ Model fusion to change timbres (using ckpt processing tab->ckpt merge);
41+
+ Easy-to-use WebUI;
42+
+ UVR5 model to quickly separate vocals and instruments;
43+
+ 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;
44+
+ AMD/Intel graphics cards acceleration supported;
45+
+ Intel ARC graphics cards acceleration with IPEX supported.
4446

45-
点此查看我们的[演示视频](https://www.bilibili.com/video/BV1pm4y1z7Gm/) !
47+
Check out our [Demo Video](https://www.bilibili.com/video/BV1pm4y1z7Gm/) here!
4648

47-
## 环境配置
48-
### Python 版本限制
49-
> 建议使用 conda 管理 Python 环境
49+
## Environment Configuration
50+
### Python Version Limitation
51+
> It is recommended to use conda to manage the Python environment.
5052
51-
> 版本限制原因参见此[bug](https://github.com/facebookresearch/fairseq/issues/5012)
53+
> For the reason of the version limitation, please refer to this [bug](https://github.com/facebookresearch/fairseq/issues/5012).
5254
5355
```bash
5456
python --version # 3.8 <= Python < 3.11
5557
```
5658

57-
### Linux/MacOS 一键依赖安装启动脚本
58-
执行项目根目录下`run.sh`即可一键配置`venv`虚拟环境、自动安装所需依赖并启动主程序。
59+
### Linux/MacOS One-click Dependency Installation & Startup Script
60+
By executing `run.sh` in the project root directory, you can configure the `venv` virtual environment, automatically install the required dependencies, and start the main program with one click.
5961
```bash
6062
sh ./run.sh
6163
```
6264

63-
### 手动安装依赖
64-
1. 安装`pytorch`及其核心依赖,若已安装则跳过。参考自: https://pytorch.org/get-started/locally/
65+
### Manual Installation of Dependencies
66+
1. Install `pytorch` and its core dependencies, skip if already installed. Refer to: https://pytorch.org/get-started/locally/
6567
```bash
6668
pip install torch torchvision torchaudio
6769
```
68-
2. 如果是 win 系统 + Nvidia Ampere 架构(RTX30xx),根据 #21 的经验,需要指定 pytorch 对应的 CUDA 版本
70+
2. If you are using Nvidia Ampere architecture (RTX30xx) in Windows, according to the experience of #21, you need to specify the cuda version corresponding to pytorch.
6971
```bash
7072
pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu117
7173
```
72-
3. 根据自己的显卡安装对应依赖
73-
- N卡
74+
3. Install the corresponding dependencies according to your own graphics card.
75+
- Nvidia GPU
7476
```bash
7577
pip install -r requirements/main.txt
7678
```
77-
- A卡/I卡
79+
- AMD/Intel GPU
7880
```bash
7981
pip install -r requirements/dml.txt
8082
```
81-
- A卡ROCM(Linux)
83+
- AMD ROCM (Linux)
8284
```bash
8385
pip install -r requirements/amd.txt
8486
```
85-
- I卡IPEX(Linux)
87+
- Intel IPEX (Linux)
8688
```bash
8789
pip install -r requirements/ipex.txt
8890
```
8991

90-
## 其他资源准备
91-
### 1. assets
92-
> RVC需要位于`assets`文件夹下的一些模型资源进行推理和训练。
93-
#### 自动检查/下载资源(默认)
94-
> 默认情况下,RVC可在主程序启动时自动检查所需资源的完整性。
92+
## Preparation of Other Files
93+
### 1. Assets
94+
> RVC requires some models located in the `assets` folder for inference and training.
95+
#### Check/Download Automatically (Default)
96+
> By default, RVC can automatically check the integrity of the required resources when the main program starts.
9597
96-
> 即使资源不完整,程序也将继续启动。
98+
> Even if the resources are not complete, the program will continue to start.
9799
98-
- 如果您希望下载所有资源,请添加`--update`参数
99-
- 如果您希望跳过启动时的资源完整性检查,请添加`--nocheck`参数
100+
- If you want to download all resources, please add the `--update` parameter.
101+
- If you want to skip the resource integrity check at startup, please add the `--nocheck` parameter.
100102

101-
#### 手动下载资源
102-
> 所有资源文件均位于[Hugging Face space](https://huggingface.co/lj1995/VoiceConversionWebUI/tree/main/)
103+
#### Download Manually
104+
> All resource files are located in [Hugging Face space](https://huggingface.co/lj1995/VoiceConversionWebUI/tree/main/)
103105
104-
> 你可以在`tools`文件夹找到下载它们的脚本
106+
> You can find some scripts to download them in the `tools` folder
105107
106-
> 你也可以使用模型/整合包/工具的一键下载器:[RVC-Models-Downloader](https://github.com/fumiama/RVC-Models-Downloader)
108+
> You can also use the [one-click downloader](https://github.com/fumiama/RVC-Models-Downloader) for models/integration packages/tools
107109
108-
以下是一份清单,包括了所有RVC所需的预模型和其他文件的名称。
110+
Below is a list that includes the names of all pre-models and other files required by RVC.
109111

110112
- ./assets/hubert/hubert_base.pt
111113
```bash
@@ -119,90 +121,88 @@ sh ./run.sh
119121
```bash
120122
rvcmd assets/uvr5 # RVC-Models-Downloader command
121123
```
122-
想使用v2版本模型的话,需要额外下载
124+
If you want to use the v2 version of the model, you need to download additional resources in
123125

124126
- ./assets/pretrained_v2
125127
```bash
126128
rvcmd assets/v2 # RVC-Models-Downloader command
127129
```
128130

129-
### 2. 安装 ffmpeg 工具
130-
若已安装`ffmpeg``ffprobe`则可跳过此步骤。
131-
132-
#### Ubuntu/Debian 用户
131+
### 2. Install ffmpeg tool
132+
If `ffmpeg` and `ffprobe` have already been installed, you can skip this step.
133+
#### Ubuntu/Debian
133134
```bash
134135
sudo apt install ffmpeg
135136
```
136-
#### MacOS 用户
137+
#### MacOS
137138
```bash
138139
brew install ffmpeg
139140
```
140-
#### Windows 用户
141-
下载后放置在根目录。
141+
#### Windows
142+
After downloading, place it in the root directory.
142143
```bash
143144
rvcmd tools/ffmpeg # RVC-Models-Downloader command
144145
```
145-
- 下载[ffmpeg.exe](https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/ffmpeg.exe)
146+
- [ffmpeg.exe](https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/ffmpeg.exe)
146147

147-
- 下载[ffprobe.exe](https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/ffprobe.exe)
148+
- [ffprobe.exe](https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/ffprobe.exe)
148149

149-
### 3. 下载 rmvpe 人声音高提取算法所需文件
150+
### 3. Download the required files for the rmvpe vocal pitch extraction algorithm
150151

151-
如果你想使用最新的RMVPE人声音高提取算法,则你需要下载音高提取模型参数并放置于`assets/rmvpe`
152+
If you want to use the latest RMVPE vocal pitch extraction algorithm, you need to download the pitch extraction model parameters and place them in `assets/rmvpe`.
152153

153-
- 下载[rmvpe.pt](https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/rmvpe.pt)
154+
- [rmvpe.pt](https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/rmvpe.pt)
154155
```bash
155156
rvcmd assets/rmvpe # RVC-Models-Downloader command
156157
```
157158

158-
#### 下载 rmvpe 的 dml 环境(可选, A卡/I卡用户)
159+
#### Download DML environment of RMVPE (optional, for AMD/Intel GPU)
159160

160-
- 下载[rmvpe.onnx](https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/rmvpe.onnx)
161+
- [rmvpe.onnx](https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/rmvpe.onnx)
161162
```bash
162163
rvcmd assets/rmvpe # RVC-Models-Downloader command
163164
```
164165

165-
### 4. AMD显卡Rocm(可选, 仅Linux)
166+
### 4. AMD ROCM (optional, Linux only)
166167

167-
如果你想基于AMD的Rocm技术在Linux系统上运行RVC,请先在[这里](https://rocm.docs.amd.com/en/latest/deploy/linux/os-native/install.html)安装所需的驱动。
168+
If you want to run RVC on a Linux system based on AMD's ROCM technology, please first install the required drivers [here](https://rocm.docs.amd.com/en/latest/deploy/linux/os-native/install.html).
168169

169-
若你使用的是Arch Linux,可以使用pacman来安装所需驱动:
170+
If you are using Arch Linux, you can use pacman to install the required drivers.
170171
````
171172
pacman -S rocm-hip-sdk rocm-opencl-sdk
172173
````
173-
对于某些型号的显卡,你可能需要额外配置如下的环境变量(如:RX6700XT):
174+
For some models of graphics cards, you may need to configure the following environment variables (such as: RX6700XT).
174175
````
175176
export ROCM_PATH=/opt/rocm
176177
export HSA_OVERRIDE_GFX_VERSION=10.3.0
177178
````
178-
同时确保你的当前用户处于`render``video`用户组内:
179+
Also, make sure your current user is in the `render` and `video` user groups.
179180
````
180181
sudo usermod -aG render $USERNAME
181182
sudo usermod -aG video $USERNAME
182183
````
183-
184-
## 开始使用
185-
### 直接启动
186-
使用以下指令来启动 WebUI
184+
## Getting Started
185+
### Direct Launch
186+
Use the following command to start the WebUI.
187187
```bash
188188
python web.py
189189
```
190-
### Linux/MacOS 用户
190+
### Linux/MacOS
191191
```bash
192192
./run.sh
193193
```
194-
### 对于需要使用IPEX技术的I卡用户(仅Linux)
194+
### For I-card users who need to use IPEX technology (Linux only)
195195
```bash
196196
source /opt/intel/oneapi/setvars.sh
197197
./run.sh
198198
```
199-
### 使用整合包 (Windows 用户)
200-
下载并解压`RVC-beta.7z`,解压后双击`go-web.bat`即可一键启动。
199+
### Using the Integration Package (Windows Users)
200+
Download and unzip `RVC-beta.7z`. After unzipping, double-click `go-web.bat` to start the program with one click.
201201
```bash
202202
rvcmd packs/general/latest # RVC-Models-Downloader command
203203
```
204204

205-
## 参考项目
205+
## Credits
206206
+ [ContentVec](https://github.com/auspicious3000/contentvec/)
207207
+ [VITS](https://github.com/jaywalnut310/vits)
208208
+ [HIFIGAN](https://github.com/jik876/hifi-gan)
@@ -213,5 +213,5 @@ rvcmd packs/general/latest # RVC-Models-Downloader command
213213
+ [Vocal pitch extraction:RMVPE](https://github.com/Dream-High/RMVPE)
214214
+ The pretrained model is trained and tested by [yxlllc](https://github.com/yxlllc/RMVPE) and [RVC-Boss](https://github.com/RVC-Boss).
215215

216-
## 感谢所有贡献者作出的努力
216+
## Thanks to all contributors for their efforts
217217
[![contributors](https://contrib.rocks/image?repo=fumiama/Retrieval-based-Voice-Conversion-WebUI)](https://github.com/fumiama/Retrieval-based-Voice-Conversion-WebUI/graphs/contributors)

0 commit comments

Comments
 (0)