From b9fbce73a9b26f7e5b0a1478bf94e83915c29dd8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=BA=90=E6=96=87=E9=9B=A8?= <41315874+fumiama@users.noreply.github.com> Date: Fri, 29 Dec 2023 01:23:16 +0900 Subject: [PATCH] =?UTF-8?q?=E5=A4=A7=E5=B9=85=E4=BC=98=E5=8C=96README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 165 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 91 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index 9ab6c2f..331edfd 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,13 @@ [**更新日志**](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://modelscope.cn/studios/FlowerCry/RVCv2demo) - - ------- - [**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) -点此查看我们的[演示视频](https://www.bilibili.com/video/BV1pm4y1z7Gm/) ! + + +> 底模使用接近50小时的开源高质量VCTK训练集训练，无版权方面的顾虑，请大家放心使用 + +> 请期待RVCv3的底模，参数更大，数据更大，效果更好，基本持平的推理速度，需要训练数据量更少。 @@ -43,10 +43,6 @@
-> 底模使用接近50小时的开源高质量VCTK训练集训练，无版权方面的顾虑，请大家放心使用 - -> 请期待RVCv3的底模，参数更大，数据更大，效果更好，基本持平的推理速度，需要训练数据量更少。 - ## 简介 本仓库具有以下特点 + 使用top1检索替换输入源特征为训练集特征来杜绝音色泄漏 @@ -58,47 +54,52 @@ + 使用最先进的[人声音高提取算法InterSpeech2023-RMVPE](#参考项目)根绝哑音问题。效果最好（显著地）但比crepe_full更快、资源占用更小 + A卡I卡加速支持 +点此查看我们的[演示视频](https://www.bilibili.com/video/BV1pm4y1z7Gm/) ! + ## 环境配置 以下指令需在 Python 版本大于3.8的环境中执行。 -(Windows/Linux) -首先通过 pip 安装主要依赖: +### Windows/Linux/MacOS等平台通用方法 +下列方法任选其一。 +#### 1. 通过 pip 安装依赖 +1. 安装Pytorch及其核心依赖，若已安装则跳过。参考自: https://pytorch.org/get-started/locally/ ```bash -# 安装Pytorch及其核心依赖，若已安装则跳过 -# 参考自: https://pytorch.org/get-started/locally/ pip install torch torchvision torchaudio - -#如果是win系统+Nvidia Ampere架构(RTX30xx)，根据 #21 的经验，需要指定pytorch对应的cuda版本 -#pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu117 +``` +2. 如果是 win 系统 + Nvidia Ampere 架构(RTX30xx)，根据 #21 的经验，需要指定 pytorch 对应的 cuda 版本 +```bash +pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu117 +``` +3. 根据自己的显卡安装对应依赖 +- N卡 +```bash +pip install -r requirements.txt +``` +- A卡/I卡 +```bash +pip install -r requirements-dml.txt +``` +- A卡ROCM(Linux) +```bash +pip install -r requirements-amd.txt +``` +- I卡IPEX(Linux) +```bash +pip install -r requirements-ipex.txt ``` -可以使用 poetry 来安装依赖： +#### 2. 通过 poetry 来安装依赖 +安装 Poetry 依赖管理工具，若已安装则跳过。参考自: https://python-poetry.org/docs/#installation ```bash -# 安装 Poetry 依赖管理工具, 若已安装则跳过 -# 参考自: https://python-poetry.org/docs/#installation curl -sSL https://install.python-poetry.org | python3 - - -# 通过poetry安装依赖 +``` +通过poetry安装依赖 +```bash poetry install ``` -你也可以通过 pip 来安装依赖： -```bash -N卡： - pip install -r requirements.txt - -A卡/I卡： - pip install -r requirements-dml.txt - -A卡Rocm（Linux）： - pip install -r requirements-amd.txt - -I卡IPEX（Linux）： - pip install -r requirements-ipex.txt -``` - ------- -Mac 用户可以通过 `run.sh` 来安装依赖： +### MacOS +可以通过 `run.sh` 来安装依赖 ```bash sh ./run.sh ``` @@ -108,48 +109,47 @@ RVC需要其他一些预模型来推理和训练。 你可以从我们的[Hugging Face space](https://huggingface.co/lj1995/VoiceConversionWebUI/tree/main/)下载到这些模型。 -以下是一份清单，包括了所有RVC所需的预模型和其他文件的名称: +### 1. 下载 assets +以下是一份清单，包括了所有RVC所需的预模型和其他文件的名称。你可以在`tools`文件夹找到下载它们的脚本。 + +- ./assets/hubert/hubert_base.pt + +- ./assets/pretrained + +- ./assets/uvr5_weights + +想使用v2版本模型的话，需要额外下载 + +- ./assets/pretrained_v2 + +### 2. 安装 ffmpeg +若ffmpeg和ffprobe已安装则跳过。 + +#### Ubuntu/Debian 用户 ```bash -./assets/hubert/hubert_base.pt - -./assets/pretrained - -./assets/uvr5_weights - -想测试v2版本模型的话，需要额外下载 - -./assets/pretrained_v2 - -如果你正在使用Windows，则你可能需要这个文件，若ffmpeg和ffprobe已安装则跳过; ubuntu/debian 用户可以通过apt install ffmpeg来安装这2个库, Mac 用户则可以通过brew install ffmpeg来安装 (需要预先安装brew) - -./ffmpeg - -https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/ffmpeg.exe - -./ffprobe - -https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/ffprobe.exe - -如果你想使用最新的RMVPE人声音高提取算法，则你需要下载音高提取模型参数并放置于RVC根目录 - -https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/rmvpe.pt - - A卡I卡用户需要的dml环境要请下载 - - https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/rmvpe.onnx - +sudo apt install ffmpeg ``` -之后使用以下指令来启动WebUI: +#### MacOS 用户 ```bash -python infer-web.py +brew install ffmpeg ``` -如果你正在使用Windows 或 macOS，你可以直接下载并解压`RVC-beta.7z`，前者可以运行`go-web.bat`以启动WebUI，后者则运行命令`sh ./run.sh`以启动WebUI。 +#### Windwos 用户 +下载后放置在根目录。 +- 下载[ffmpeg.exe](https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/ffmpeg.exe) -对于需要使用IPEX技术的I卡用户，请先在终端执行`source /opt/intel/oneapi/setvars.sh`（仅Linux）。 +- 下载[ffprobe.exe](https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/ffprobe.exe) -仓库内还有一份`小白简易教程.doc`以供参考。 +### 3. 下载 rmvpe 人声音高提取算法所需文件 -## AMD显卡Rocm相关（仅Linux） +如果你想使用最新的RMVPE人声音高提取算法，则你需要下载音高提取模型参数并放置于RVC根目录。 + +- 下载[rmvpe.pt](https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/rmvpe.pt) + +#### 下载 rmvpe 的 dml 环境(可选, A卡/I卡用户) + +- 下载[rmvpe.onnx](https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/rmvpe.onnx) + +## 4. AMD显卡Rocm(可选, 仅Linux) 如果你想基于AMD的Rocm技术在Linux系统上运行RVC，请先在[这里](https://rocm.docs.amd.com/en/latest/deploy/linux/os-native/install.html)安装所需的驱动。 若你使用的是Arch Linux，可以使用pacman来安装所需驱动： @@ -166,10 +166,27 @@ export HSA_OVERRIDE_GFX_VERSION=10.3.0 sudo usermod -aG render $USERNAME sudo usermod -aG video $USERNAME ```` -之后运行WebUI： + +## 开始使用 +### 直接启动 +使用以下指令来启动 WebUI ```bash python infer-web.py ``` +### 使用整合包 +下载并解压`RVC-beta.7z` +#### Windows 用户 +双击`go-web.bat` +#### MacOS 用户 +```bash +sh ./run.sh +``` +### 对于需要使用IPEX技术的I卡用户(仅Linux) +```bash +source /opt/intel/oneapi/setvars.sh +``` + +仓库内还有一份[小白简易教程.doc](/docs/小白简易教程.doc)以供参考。 ## 参考项目 + [ContentVec](https://github.com/auspicious3000/contentvec/)