mirror of
https://github.com/storytold/storyteller-ml.git
synced 2026-10-17 00:23:14 +00:00
Brandon Thomas
168 lines
8.8 KiB
Markdown
168 lines
8.8 KiB
Markdown
# SoftVC VITS Singing Voice Conversion Fork
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/34j/so-vits-svc-fork/actions/workflows/ci.yml?query=branch%3Amain">
|
|
<img src="https://img.shields.io/github/actions/workflow/status/34j/so-vits-svc-fork/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
|
|
</a>
|
|
<a href="https://so-vits-svc-fork.readthedocs.io">
|
|
<img src="https://img.shields.io/readthedocs/so-vits-svc-fork.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
|
|
</a>
|
|
<a href="https://codecov.io/gh/34j/so-vits-svc-fork">
|
|
<img src="https://img.shields.io/codecov/c/github/34j/so-vits-svc-fork.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://python-poetry.org/">
|
|
<img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">
|
|
</a>
|
|
<a href="https://github.com/ambv/black">
|
|
<img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square" alt="black">
|
|
</a>
|
|
<a href="https://github.com/pre-commit/pre-commit">
|
|
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://pypi.org/project/so-vits-svc-fork/">
|
|
<img src="https://img.shields.io/pypi/v/so-vits-svc-fork.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
|
|
</a>
|
|
<img src="https://img.shields.io/pypi/pyversions/so-vits-svc-fork.svg?style=flat-square&logo=python&logoColor=fff" alt="Supported Python versions">
|
|
<img src="https://img.shields.io/pypi/l/so-vits-svc-fork.svg?style=flat-square" alt="License">
|
|
</p>
|
|
|
|
A fork of [`so-vits-svc`](https://github.com/svc-develop-team/so-vits-svc) with **realtime support** and **greatly improved interface**. Based on branch `4.0` (v1) and the models are compatible.
|
|
|
|
## Installation
|
|
|
|
Install this via pip (or your favourite package manager):
|
|
|
|
```shell
|
|
pip install -U torch torchaudio --index-url https://download.pytorch.org/whl/cu117
|
|
pip install so-vits-svc-fork
|
|
```
|
|
|
|
## Features not available in the original repo
|
|
|
|
- **Realtime voice conversion** (enhanced in v1.1.0)
|
|
- More accurate pitch estimation using CREPE
|
|
- GUI available
|
|
- Unified command-line interface (no need to run Python scripts)
|
|
- Ready to use just by installing with `pip`.
|
|
- Automatically download pretrained base model and HuBERT model
|
|
- Code completely formatted with black, isort, autoflake etc.
|
|
- Volume normalization in preprocessing
|
|
- Other minor differences
|
|
|
|
## Usage
|
|
|
|
### Inference
|
|
|
|
#### GUI
|
|
|
|
|
|
|
|
GUI launches with the following command:
|
|
|
|
```shell
|
|
svcg
|
|
```
|
|
|
|
#### CLI
|
|
|
|
- Realtime (from microphone)
|
|
|
|
```shell
|
|
svc vc --model-path <model-path>
|
|
```
|
|
|
|
- File
|
|
|
|
```shell
|
|
svc --model-path <model-path> source.wav
|
|
```
|
|
|
|
#### Notes
|
|
|
|
- In real-time inference, if there is noise on the inputs, the HuBERT model will react to those as well. Consider using realtime noise reduction applications such as [RTX Voice](https://www.nvidia.com/en-us/geforce/guides/nvidia-rtx-voice-setup-guide/) in this case.
|
|
|
|
### Training
|
|
|
|
#### Google Colab
|
|
|
|
[](https://colab.research.google.com/github/34j/so-vits-svc-fork/blob/main/notebooks/so-vits-svc-fork-4.0.ipynb)
|
|
|
|
#### Local
|
|
|
|
Place your dataset like `dataset_raw/{speaker_id}/**/{wav_file}.{any_format}` (subfolders are acceptable) and run:
|
|
|
|
```shell
|
|
svc pre-resample
|
|
svc pre-config
|
|
svc pre-hubert
|
|
svc train
|
|
```
|
|
|
|
#### Notes
|
|
|
|
- Dataset audio duration per file should be <~ 10s or VRAM will run out.
|
|
- It is recommended to change the batch_size in `config.json` before the `train` command to match the VRAM capacity. As tested, the default requires about 14 GB.
|
|
|
|
### Further help
|
|
|
|
For more details, run `svc -h` or `svc <subcommand> -h`.
|
|
|
|
```shell
|
|
> svc -h
|
|
Usage: svc [OPTIONS] COMMAND [ARGS]...
|
|
|
|
so-vits-svc allows any folder structure for training data.
|
|
However, the following folder structure is recommended.
|
|
When training: dataset_raw/{speaker_name}/{wav_name}.wav
|
|
When inference: configs/44k/config.json, logs/44k/G_XXXX.pth
|
|
If the folder structure is followed, you DO NOT NEED TO SPECIFY model path, config path, etc.
|
|
(The latest model will be automatically loaded.)
|
|
To train a model, run pre-resample, pre-config, pre-hubert, train.
|
|
To infer a model, run infer.
|
|
|
|
Options:
|
|
-h, --help Show this message and exit.
|
|
|
|
Commands:
|
|
clean Clean up files, only useful if you are using the default file structure
|
|
infer Inference
|
|
onnx Export model to onnx
|
|
pre-config Preprocessing part 2: config
|
|
pre-hubert Preprocessing part 3: hubert If the HuBERT model is not found, it will be...
|
|
pre-resample Preprocessing part 1: resample
|
|
train Train model If D_0.pth or G_0.pth not found, automatically download from hub.
|
|
train-cluster Train k-means clustering
|
|
vc Realtime inference from microphone
|
|
```
|
|
|
|
## Contributors ✨
|
|
|
|
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
|
|
|
<!-- prettier-ignore-start -->
|
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/34j"><img src="https://avatars.githubusercontent.com/u/55338215?v=4?s=80" width="80px;" alt="34j"/><br /><sub><b>34j</b></sub></a><br /><a href="https://github.com/34j/so-vits-svc-fork/commits?author=34j" title="Code">💻</a> <a href="#ideas-34j" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/34j/so-vits-svc-fork/commits?author=34j" title="Documentation">📖</a> <a href="#example-34j" title="Examples">💡</a> <a href="#infra-34j" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-34j" title="Maintenance">🚧</a> <a href="https://github.com/34j/so-vits-svc-fork/pulls?q=is%3Apr+reviewed-by%3A34j" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/34j/so-vits-svc-fork/commits?author=34j" title="Tests">⚠️</a> <a href="#tutorial-34j" title="Tutorials">✅</a> <a href="#promotion-34j" title="Promotion">📣</a> <a href="https://github.com/34j/so-vits-svc-fork/issues?q=author%3A34j" title="Bug reports">🐛</a></td>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/GarrettConway"><img src="https://avatars.githubusercontent.com/u/22782004?v=4?s=80" width="80px;" alt="GarrettConway"/><br /><sub><b>GarrettConway</b></sub></a><br /><a href="https://github.com/34j/so-vits-svc-fork/commits?author=GarrettConway" title="Code">💻</a> <a href="https://github.com/34j/so-vits-svc-fork/issues?q=author%3AGarrettConway" title="Bug reports">🐛</a></td>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/BlueAmulet"><img src="https://avatars.githubusercontent.com/u/43395286?v=4?s=80" width="80px;" alt="BlueAmulet"/><br /><sub><b>BlueAmulet</b></sub></a><br /><a href="#ideas-BlueAmulet" title="Ideas, Planning, & Feedback">🤔</a></td>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ThrowawayAccount01"><img src="https://avatars.githubusercontent.com/u/125531852?v=4?s=80" width="80px;" alt="ThrowawayAccount01"/><br /><sub><b>ThrowawayAccount01</b></sub></a><br /><a href="https://github.com/34j/so-vits-svc-fork/issues?q=author%3AThrowawayAccount01" title="Bug reports">🐛</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|