UVR5-UI

<h1 align="center"><b> 🎵 UVR5 UI 🎵 </b></h1> <div align="center">

<a target="_blank" href="https://lightning.ai/new?repo_url=https%3A%2F%2Fgithub.com%2FEddycrack864%2FUVR5-UI%2Fblob%2Fmain%2FUVR_UI.ipynb"> <img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open in Studio"/></a>

This project is based on python-audio-separator (a CLI version of UVR5). This project was originally created for the AI ​​HUB community.

</div> <div align="center">

You can also try it on HuggingFace Spaces running with Zero GPU (A100)!

</div> <div align="center">

Docs / Troubleshooting

</div>

Features:

• User Friendly Interface
• All VR Arch Models
• All MDX-NET Models
• Demucs v4 Models
• MDX23C Models
• Mel-Band Roformer Models
• BS Roformer Models
• Music Source Separation Models
• VIP Models
• Separation of an audio/video from all sites supported by yt_dlp. Check the complete list here.
• Batch Separation
• Available in multiple languages
• Colab/Kaggle/Lightning.ai support
• Windows/Linux support

Requirements

Hardware Requirements:

• Nvidia Series 2000 (RTX) or higher.
• At least 10Gb of disk space.

[!NOTE]
Older NVIDIA GPUs will be very slow. CPU will be insanely slow. If you don't meet the hardware requirements use our Colab/Kaggle/Lightning.ai/Hugging Face.

Prerequisites:

• Git. You can download Git here.
• FFmpeg. You can download FFmpeg here or you can use my automated installation script (for Windows).
• For linux users, run this command on an terminal: (Debian and Ubuntu users): sudo apt install ffmpeg git (For Arch linux users): sudo pacman -S ffmpeg git (For Fedora users): sudo dnf install ffmpeg git (Some distributions already come with Git and FFmpeg preinstalled so this step may be optional.)

[!IMPORTANT]
FFmpeg has to be added to the PATH. (only needed on Windows)

Getting Started

Clone the repository (git needed) or download the source code of the latest release here

git clone https://github.com/Eddycrack864/UVR5-UI.git

Then continue with the steps described below

1. Installation

Run the installation script based on your operating system:

• Windows: Double-click UVR5-UI-installer.bat (DONT RUN AS ADMINISTRATOR 🚧).
• Linux: Run UVR5-UI-installer.sh with chmod +x UVR5-UI-installer.sh and ./UVR5-UI-installer.sh.

[!TIP] I personally recommend running the updater before installing to make sure you have the latest changes.

2. Running UVR5 UI

Start UVR5 UI using:

• Windows: Double-click run-UVR5-UI.bat.
• Linux: Run run-UVR5-UI.sh with chmod +x run-UVR5-UI.sh and ./run-UVR5-UI.sh.

3. Update UVR5 UI (If you want/need it)

Update UVR5 UI using (git needed):

• Windows: Double-click UVR5-UI-updater.bat.
• Linux: Run UVR5-UI-updater.sh with chmod +x UVR5-UI-updater.sh and ./UVR5-UI-updater.sh.

If you find an error when installing or running the program please consult this troubleshooting file first, if your error is not described there please create an issue

4. Debug (If you want/need it)

Check the status of audio-separator core:

• Windows: Double-click status-checker.bat.
• Linux: Run status-checker.sh with chmod +x status-checker.sh and ./status-checker.sh.

Precompiled Version

1. Get the precompiled version (.zip) for your PC:

   • Windows
   • Linux

2. Extract the .zip file, I recommend using the "extract here" option.

3. You can now use all the features of the normal installation.

[!NOTE]
Still, to update UVR5 UI you need to install Git.

Docker Instance

A more technical level is required for this type of use. You can use this Jupyter notebook to initialize UVR5 on virtual machines with GPU. This will install the entire UVR5 from the main branch of GitHub.

Requirements/Recommendations

• Use the docker image >= ubuntu/ubuntu:20.04
• At least 20 GB of storage minimum. (Add more space for your models/training)
• Use Jupyter >= 7.3.1
• Configure port forwarding 9999 (UVR5-UI GUI)
• Install necessary drivers to use the GPU

You can get the notebook here: Jupyter Notebook by iroaK

Credits

• python-audio-separator by beveradb.
• Special thanks to Ilaria for hosting this space and help 💖
• Thanks to Mikus for the help with the code.
• Thanks to Nick088 for the help to fix roformers.
• Thanks to yt_dlp devs.
• Improvements by Blane187.
• Separation by link source code and improvements by Blane187.
• Thanks to ArisDev for porting UVR5 UI to Kaggle and improvements.