README.md

SoftVC VITS Singing Voice Conversion Fork

简体中文

A fork of so-vits-svc with realtime support and greatly improved interface. Based on branch 4.0 (v1) (or 4.1) and the models are compatible.

Features not available in the original repo

• Realtime voice conversion (enhanced in v1.1.0)
• Integrates QuickVC
• Fixed misuse of ContentVec in the original repository.¹
• More accurate pitch estimation using CREPE.
• GUI and unified CLI available
• ~2x faster training
• Ready to use just by installing with pip.
• Automatically download pretrained models. No need to install fairseq.
• Code completely formatted with black, isort, autoflake etc.

Installation

Option 1. One click easy installation

This BAT file will automatically perform the steps described below.

Option 2. Manual installation (using pipx, experimental)

1. Installing pipx

Windows (development version required due to pypa/pipx#940):

py -3 -m pip install --user git+https://github.com/pypa/pipx.git
py -3 -m pipx ensurepath

Linux/MacOS:

python -m pip install --user pipx
python -m pipx ensurepath

2. Installing so-vits-svc-fork

pipx install so-vits-svc-fork --python=3.10
pipx inject so-vits-svc-fork torch torchaudio --pip-args="--upgrade" --index-url=https://download.pytorch.org/whl/cu118 # https://download.pytorch.org/whl/nightly/cu121

Option 3. Manual installation

Creating a virtual environment

Windows:

py -3.10 -m venv venv
venv\Scripts\activate

Linux/MacOS:

python3.10 -m venv venv
source venv/bin/activate

Anaconda:

conda create -n so-vits-svc-fork python=3.10 pip
conda activate so-vits-svc-fork

Installing without creating a virtual environment may cause a PermissionError if Python is installed in Program Files, etc.

Install this via pip (or your favourite package manager that uses pip):

python -m pip install -U pip setuptools wheel
pip install -U torch torchaudio --index-url https://download.pytorch.org/whl/cu118 # https://download.pytorch.org/whl/nightly/cu121
pip install -U so-vits-svc-fork

Notes

• If no GPU is available or using MacOS, simply remove pip install -U torch torchaudio --index-url https://download.pytorch.org/whl/cu118. MPS is probably supported.
• If you are using an AMD GPU on Linux, replace --index-url https://download.pytorch.org/whl/cu118 with --index-url https://download.pytorch.org/whl/nightly/rocm5.6. AMD GPUs are not supported on Windows (#120).

Update

Please update this package regularly to get the latest features and bug fixes.

pip install -U so-vits-svc-fork
# pipx upgrade so-vits-svc-fork

Usage

Inference

GUI

GUI launches with the following command:

svcg

CLI

• Realtime (from microphone)

svc vc

• File

svc infer source.wav

Pretrained models are available on Hugging Face or CIVITAI.

Notes

• If using WSL, please note that WSL requires additional setup to handle audio and the GUI will not work without finding an audio device.
• 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 in this case.
• Models other than for 4.0v1 or this repository are not supported.
• GPU inference requires at least 4 GB of VRAM. If it does not work, try CPU inference as it is fast enough. ²

Training

Before training

• If your dataset has BGM, please remove the BGM using software such as Ultimate Vocal Remover. 3_HP-Vocal-UVR.pth or UVR-MDX-NET Main is recommended. ³
• If your dataset is a long audio file with a single speaker, use svc pre-split to split the dataset into multiple files (using librosa).
• If your dataset is a long audio file with multiple speakers, use svc pre-sd to split the dataset into multiple files (using pyannote.audio). Further manual classification may be necessary due to accuracy issues. If speakers speak with a variety of speech styles, set --min-speakers larger than the actual number of speakers. Due to unresolved dependencies, please install pyannote.audio manually: pip install pyannote-audio.
• To manually classify audio files, svc pre-classify is available. Up and down arrow keys can be used to change the playback speed.

Cloud

⁴

If you do not have access to a GPU with more than 10 GB of VRAM, the free plan of Google Colab is recommended for light users and the Pro/Growth plan of Paperspace is recommended for heavy users. Conversely, if you have access to a high-end GPU, the use of cloud services is not recommended.

Local

Place your dataset like dataset_raw/{speaker_id}/**/{wav_file}.{any_format} (subfolders and non-ASCII filenames are acceptable) and run:

svc pre-resample
svc pre-config
svc pre-hubert
svc train -t

Notes

• Dataset audio duration per file should be <~ 10s.
• Need at least 4GB of VRAM. ⁵
• It is recommended to increase the batch_size as much as possible in config.json before the train command to match the VRAM capacity. Setting batch_size to auto-{init_batch_size}-{max_n_trials} (or simply auto) will automatically increase batch_size until OOM error occurs, but may not be useful in some cases.
• To use CREPE, replace svc pre-hubert with svc pre-hubert -fm crepe.
• To use ContentVec correctly, replace svc pre-config with -t so-vits-svc-4.0v1. Training may take slightly longer because some weights are reset due to reusing legacy initial generator weights.
• To use MS-iSTFT Decoder, replace svc pre-config with svc pre-config -t quickvc.
• Silence removal and volume normalization are automatically performed (as in the upstream repo) and are not required.
• If you have trained on a large, copyright-free dataset, consider releasing it as an initial model.
• For further details (e.g. parameters, etc.), you can see the Wiki or Discussions.

Further help

For more details, run svc -h or svc <subcommand> -h.

> 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}.{any_format}
      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 (currently not working)
  pre-classify   Classify multiple audio files into multiple files
  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
  pre-sd         Speech diarization using pyannote.audio
  pre-split      Split audio files into multiple files
  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

External Links

Video Tutorial

Contributors ✨

Thanks goes to these wonderful people (emoji key):

34j 💻 🤔 📖 💡 🚇 🚧 👀 ⚠️ ✅ 📣 🐛	GarrettConway 💻 🐛 📖 👀	BlueAmulet 🤔 💬 💻 🚧	ThrowawayAccount01 🐛	緋 📖 🐛	Lordmau5 🐛 💻 🤔 🚧 💬 📓	DL909 🐛
Satisfy256 🐛	Pierluigi Zagaria 📓	ruckusmattster 🐛	Desuka-art 🐛	heyfixit 📖	Nerdy Rodent 📹	谢宇 📖
ColdCawfee 🐛	sbersier 🤔 📓 🐛	Meldoner 🐛 🤔 💻	mmodeusher 🐛	AlonDan 🐛	Likkkez 🐛	Duct Tape Games 🐛
Xianglong He 🐛	75aosu 🐛	tonyco82 🐛	yxlllc 🤔 💻	outhipped 🐛	escoolioinglesias 🐛 📓 📹	Blacksingh 🐛
Mgs. M. Thoyib Antarnusa 🐛	Exosfeer 🐛 💻	guranon 🐛 🤔 💻	Alexander Koumis 💻	acekagami 🌍	Highupech 🐛	Scorpi 💻
Maximxls 💻	Star3Lord 🐛 💻	Forkoz 🐛 💻	Zerui Chen 💻 🤔	Roee Shenberg 📓 🤔 💻	Justas 🐛 💻	Onako2 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Footnotes

1. #206 ↩

2. #469 ↩

3. https://ytpmv.info/how-to-use-uvr/ ↩

4. If you register a referral code and then add a payment method, you may save about $5 on your first month's monthly billing. Note that both referral rewards are Paperspace credits and not cash. It was a tough decision but inserted because debugging and training the initial model requires a large amount of computing power and the developer is a student. ↩

5. #456 ↩