Current instructions for UVR Roformer patches and installing custom models
(TL;DR)
- Your current settings might be lost after patching your current UVR installation
- Applying newer UVR Roformer versions over some older UVR versions might cause errors on startup (e.g. Python39.dll) - then perform clean installation to fix the issue. Just make sure that after uninstalling UVR, nothing is inside the old UVR folder
- To perform clean installation of the latest UVR version, for now you need:
Windows:
Roformer full patch #13
(it's actually standalone, and not just a patch - it doesn't need 5.6.0 on top):
UVR_Patch_1_15_25_22_30_BETA: Link
And then install this small patch #14 (demudder and other fixes; it needs the patch #13 in order to work):
UVR_Patch_1_21_25_2_28_BETA: Link
(it’s not standalone)
(Only for) RTX 5000 full patch #14:
UVR_Patch_4_24_25_20_11_BETA: Link
(iirc uses newer PyTorch and CUDA; standalone)
MacOS:
- Roformer full patch #13.1 (standalone)
(beta_0115_MacOS_arm64_hf)
which applies a hotfix to address a few graphics issues:
- Mac M1 (arm64) users - Link
- Mac Intel (x86_64) users - Link (it went offline for some reason; older version #13 below:
Link)
Linux:
- Old patch #9 only for now (no demudder, some fixable issues with certain models):
https://github.com/Anjok07/ultimatevocalremovergui/tree/v5.6.0_roformer_add%2Bdirectml
- Or use bottles with gaming profile using WINE on Windows newer codebase (still utilizes GPU)
“used the provided .exe file from the repository's releases. I created a new bottle with a gaming profile (to utilize GPU) and moved the exe file into "drive_c" (otherwise it won't work), then just ran through the installer and it worked like a charm” (ref)
Tested on at least RTX 5060. But using MSST instead might be faster.
(for older patches and more info and troubleshooting refer here)
- Some newer Mel/BS models really require the newest Roformer patches (otherwise you’ll get MLP error).
- In the Download Center you’ll find some BS/Mel models, but not all. Refer to the full list of models here and download them from there.
Installing custom Roformer models in UVR
(those unavailable in Download More Models a.k.a. Download Center)
- To install models from external sources (those unavailable in Download Center) since patch #10, a new “Install Model” option was added (e.g. in MDX-Net menu).
Click RBM on the models’ list to access the option and follow the instructions on your screen.
Alternatively -
Manual model installation e.g. Demucs models, which doesn’t have “Install model” option (or if you use patch before #10) - on an example of MDX/Roformers/SCNet/Bandit located in MDX-Net menu, or if you use older patch or older native Linux version, or have “Model not installed” error:
You can also copy the model file to “models\MDX_Net_Models” and the .yaml config to “models\model_data\mdx_c_configs” manually, then after choosing the model in the app, press Yes, to recognize the model, and wait a while.
In the older beta patches you need to check “roformer model” option when asked for configuration file and confirm (you cannot press confirm or check the option on the oldest Mac Roformer patch, the issue is explained later below, and fixed in newer versions, or read the fix for older Mac patch step by step)
Models for Mel/BS Roformer, SCNet and Bandit Plus/v2 are located in the MDX-Net menu.
- In “Set Model Type”, most Roformers use Roformer non-v2 (and Mel or BS, depending on what's in the model name).
For now, you should pick v2 Roformer type probably only for unwa 400MB experimental model (if you have lots of layers errors using Roformers, it means you picked v2 config unnecessarily).
- For most model archs mentioned above, you need both ckpt and yaml file for the model to work (if it’s not the same with any config you already downloaded before - some models share the same config file - e.g. one folder with models in the repository might have only one yaml, although you might want to duplicate the yaml for specific chunk_size exclusively for model of your choice)
Downloading configs
- If you opened a yaml file to download it, but its content opened without page layout instead of starting the download, press CTRL+S or go to options of your browser and find the option called “Save As”.
Now you’ll have a txt extension, but we need it to be yaml instead of txt (otherwise UVR won’t detect it), so choose All files in Extension, and edit it there manually to yaml (or manually after downloading).
If you see the config, but also page layout (e.g. on HF) just press “RAW” or “Copy download link”, and paste it to your browser and follow the above (so then save it with CTRL+A and change extension to yaml)
Or else, you can just see the list of files in the HF repo - then just click the download icon near the desired yaml file and that's it.
- If you don’t see “ckpt” on the extensions list to choose the model during using Install model option, consider performing clean UVR installation from the patches above
Misc
- You might want to decrease default chunk_size in Edit Model Param (or yaml) for AMD/Intel GPUs with VRAM lower than 16GB if you have memory errors with GPU Conversion enabled or your separation is stuck on e.g. 5% (read more in Common issues later below)
- How would I assign a yaml config to an Apollo model on the new UVR [patch]?
“1. Open the Apollo models folder
2. Drop the model into the folder
3. From the Apollo models folder, drop the yaml into the model_configs directory
4. From the GUI, choose the model you just added and if the model is not recognized, a pop-up window will appear, and you'll have the option to choose the yaml to associate with the model.” - Anjok
(iirc not used in UVR) - “batch_size = 2 (not less or more)” - “1 can lead to some clicks in output, while with batch_size>=2, there are no clicks. Clicks are obvious in low freq of log spectrogram”
edit. iirc clicks with batch_size=1 could have been fixed (at least were with MSST from which the inference code was implemented in newer UVR patches, but iirc it wasn’t used, and later the clicks were fixed in MSST).
- Segment size in the UVR UI does nothing for these Roformer models due to Advanced arch options being set by default to Segment Default which makes it being read from the yaml file. While "Segment_Default" in Advanced MDX-NET23 settings is checked, it will use the dim_t value from the bottom of the config. Simply dim_t is the segments. Although now chunk_size is used in newer patches instead.
- “The overlap value in yaml files is never used by UVR, only the value in GUI is used.”
“UVR uses inference.dim_t from config as segment_size, but the inference.num_overlap is not used by UVR, it's always using the value in the GUI
(while ZFTurbo original script is using audio.chunk_size and inference.num_overlap but not inference.dim_t . That's a mess) ” jarredou