Demucs Music Source Separation
This is the 3rd release of Demucs (v3), featuring hybrid source separation.
For the waveform only Demucs (v2): Go this commit.
If you are experiencing issues and want the old Demucs back, please fill an issue, and then you can get back to the v2 with
git checkout v2
.
We provide an implementation of Hybrid Demucs for music source separation, trained both on the MusDB HQ dataset, and with internal extra training data. They can separate drums, bass and vocals from the rest and achieved the first rank at the 2021 Sony Music DemiXing Challenge (MDX)
Demucs is based on U-Net convolutional architecture inspired by Wave-U-Net. The most recent version features hybrid spectrogram/waveform separation, along with compressed residual branches, local attention and singular value regularization. Checkout our paper Hybrid Spectrogram and Waveform Source Separation for more details. As far as we know, Demucs is currently the only model supporting true end-to-end hybrid model training with shared information between the domains, as opposed to post-training model blending.
When trained only on MusDB HQ, Hybrid Demucs achieved a SDR of 7.33 on the MDX test set, and 8.11 dB with 200 extra training tracks. It is particularly efficient for drums and bass extraction, although KUIELAB-MDX-Net performs better for vocals and other accompaniments.
Important news if you are already using Demucs
See the release notes for more details.
- 30/08/2022: added reproducibility and ablation grids, along with an updated version of the paper.
- 17/08/2022: Releasing v3.0.5: Set split segment length to reduce memory. Compatible with pyTorch 1.12.
- 24/02/2022: Releasing v3.0.4: split into two stems (i.e. karaoke mode). Export as float32 or int24.
- 17/12/2021: Releasing v3.0.3: bug fixes (thanks @keunwoochoi), memory drastically
reduced on GPU (thanks @famzah) and new multi-core evaluation on CPU (
-j
flag). - 12/11/2021: Releasing Demucs v3 with hybrid domain separation. Strong improvements on all sources. This is the model that won Sony MDX challenge.
- 11/05/2021: Adding support for MusDB-HQ and arbitrary wav set, for the MDX challenge. For more information on joining the challenge with Demucs see the Demucs MDX instructions
- 28/04/2021: Demucs v2, with extra augmentation and DiffQ based quantization.
EVERYTHING WILL BREAK, please restart from scratch following the instructions hereafter.
This version also adds overlap between prediction frames, with linear transition from one to the next,
which should prevent sudden changes at frame boundaries. Also, Demucs is now on PyPI, so for separation
only, installation is as easy as
pip install demucs
:) - 13/04/2020: Demucs released under MIT: We are happy to release Demucs under the MIT licence. We hope that this will broaden the impact of this research to new applications.
Comparison with other models
We provide hereafter a summary of the different metrics presented in the paper. You can also compare Hybrid Demucs (v3), KUIELAB-MDX-Net, Spleeter, Open-Unmix, Demucs (v1), and Conv-Tasnet on one of my favorite songs on my soundcloud playlist.
Comparison of accuracy
Overall SDR
is the mean of the SDR for each of the 4 sources, MOS Quality
is a rating from 1 to 5
of the naturalness and absence of artifacts given by human listeners (5 = no artifacts), MOS Contamination
is a rating from 1 to 5 with 5 being zero contamination by other sources. We refer the reader to our paper,
for more details.
Model | Domain | Extra data? | Overall SDR | MOS Quality | MOS Contamination |
---|---|---|---|---|---|
Wave-U-Net | waveform | no | 3.2 | - | - |
Open-Unmix | spectrogram | no | 5.3 | - | - |
D3Net | spectrogram | no | 6.0 | - | - |
Conv-Tasnet | waveform | no | 5.7 | - | |
Demucs (v2) | waveform | no | 6.3 | 2.37 | 2.36 |
ResUNetDecouple+ | spectrogram | no | 6.7 | - | - |
KUIELAB-MDX-Net | hybrid | no | 7.5 | 2.86 | 2.55 |
Hybrid Demucs (v3) | hybrid | no | 7.7 | 2.83 | 3.04 |
MMDenseLSTM | spectrogram | 804 songs | 6.0 | - | - |
D3Net | spectrogram | 1.5k songs | 6.7 | - | - |
Spleeter | spectrogram | 25k songs | 5.9 | - | - |
Requirements
You will need at least Python 3.7. See requirements_minimal.txt
for requirements for separation only,
and environment-[cpu|cuda].yml
(or requirements.txt
) if you want to train a new model.
For Windows users
Everytime you see python3
, replace it with python.exe
. You should always run commands from the
Anaconda console.
For musicians
If you just want to use Demucs to separate tracks, you can install it with
python3 -m pip install -U demucs
For bleeding edge versions, you can install directly from this repo using
python3 -m pip install -U git+https://github.com/facebookresearch/demucs#egg=demucs
Advanced OS support are provided on the following page, you must read the page for your OS before posting an issues:
- If you are using Windows: Windows support.
- If you are using MAC OS X: Mac OS X support.
- If you are using Linux: Linux support.
For machine learning scientists
If you have anaconda installed, you can run from the root of this repository:
conda env update -f environment-cpu.yml # if you don't have GPUs
conda env update -f environment-cuda.yml # if you have GPUs
conda activate demucs
pip install -e .
This will create a demucs
environment with all the dependencies installed.
You will also need to install soundstretch/soundtouch: on Mac OSX you can do brew install sound-touch
,
and on Ubuntu sudo apt-get install soundstretch
. This is used for the
pitch/tempo augmentation.
Running in Docker
Thanks to @xserrat, there is now a Docker image definition ready for using Demucs. This can ensure all libraries are correctly installed without interfering with the host OS. See his repo Docker Facebook Demucs for more information.
Running from Colab
I made a Colab to easily separate track with Demucs. Note that transfer speeds with Colab are a bit slow for large media files, but it will allow you to use Demucs without installing anything.
Web Demo
Integrated to Huggingface Spaces with Gradio. See demo:
Graphical Interface
@CarlGao4 has released a GUI for Demucs: CarlGao4/Demucs-Gui. Downloads for Windows and macOS is available here. Use FossHub mirror to speed up your download.
@Anjok07 is providing a self contained GUI in UVR (Ultimate Vocal Remover) that supports Demucs.
Other providers
Audiostrip is providing free online separation with Demucs on their website https://audiostrip.co.uk/.
MVSep also provides free online separation, select Demucs3 model B
for the best quality.
Spleeter.io provides free online separation with Demucs on their website https://www.spleeter.io/demucs.
Separating tracks
In order to try Demucs, you can just run from any folder (as long as you properly installed it)
demucs PATH_TO_AUDIO_FILE_1 [PATH_TO_AUDIO_FILE_2 ...] # for Demucs
# If you used `pip install --user` you might need to replace demucs with python3 -m demucs
python3 -m demucs --mp3 --mp3-bitrate BITRATE PATH_TO_AUDIO_FILE_1 # output files saved as MP3
# If your filename contain spaces don't forget to quote it !!!
demucs "my music/my favorite track.mp3"
# You can select different models with `-n` mdx_q is the quantized model, smaller but maybe a bit less accurate.
demucs -n mdx_q myfile.mp3
# If you only want to separate vocals out of an audio, use `--two-stems=vocal` (You can also set to drums or bass)
demucs --two-stems=vocals myfile.mp3
If you have a GPU, but you run out of memory, please use --segment SEGMENT
to reduce length of each split. SEGMENT
should be changed to a integer. Personally recommend not less than 10 (the bigger the number is, the more memory is required, but quality may increase). Create an environment variable PYTORCH_NO_CUDA_MEMORY_CACHING=1
is also helpful. If this still cannot help, please add -d cpu
to the command line. See the section hereafter for more details on the memory requirements for GPU acceleration.
Separated tracks are stored in the separated/MODEL_NAME/TRACK_NAME
folder. There you will find four stereo wav files sampled at 44.1 kHz: drums.wav
, bass.wav
,
other.wav
, vocals.wav
(or .mp3
if you used the --mp3
option).
All audio formats supported by torchaudio
can be processed (i.e. wav, mp3, flac, ogg/vorbis on Linux/Mac OS X etc.). On Windows, torchaudio
has limited support, so we rely on ffmpeg
, which should support pretty much anything.
Audio is resampled on the fly if necessary.
The output will be a wave file encoded as int16.
You can save as float32 wav files with --float32
, or 24 bits integer wav with --int24
.
You can pass --mp3
to save as mp3 instead, and set the bitrate with --mp3-bitrate
(default is 320kbps).
It can happen that the output would need clipping, in particular due to some separation artifacts.
Demucs will automatically rescale each output stem so as to avoid clipping. This can however break
the relative volume between stems. If instead you prefer hard clipping, pass --clip-mode clamp
.
You can also try to reduce the volume of the input mixture before feeding it to Demucs.
Other pre-trained models can be selected with the -n
flag.
The list of pre-trained models is:
mdx
: trained only on MusDB HQ, winning model on track A at the MDX challenge.mdx_extra
: trained with extra training data (including MusDB test set), ranked 2nd on the track B of the MDX challenge.mdx_q
,mdx_extra_q
: quantized version of the previous models. Smaller download and storage but quality can be slightly worse.mdx_extra_q
is the default model used.SIG
: whereSIG
is a single model from the model zoo.
Faster separation: if you want faster separation, in particular if you do not have a GPU, you can use -n 83fc094f
for instance to use
a single model, as opposed to the bag of 4 models used for the competition.
The --two-stems=vocals
option allows to separate vocals from the rest (e.g. karaoke mode).
vocals
can be changed into any source in the selected model.
This will mix the files after separating the mix fully, so this won't be faster or use less memory.
The --shifts=SHIFTS
performs multiple predictions with random shifts (a.k.a the shift trick) of the input and average them. This makes prediction SHIFTS
times
slower. Don't use it unless you have a GPU.
The --overlap
option controls the amount of overlap between prediction windows (for Demucs one window is 10 seconds).
Default is 0.25 (i.e. 25%) which is probably fine.
The -j
flag allow to specify a number of parallel jobs (e.g. demucs -j 2 myfile.mp3
).
This will multiply by the same amount the RAM used so be careful!
Memory requirements for GPU acceleration
If you want to use GPU acceleration, you will need at least 3GB of RAM on your GPU for demucs
. However, about 7GB of RAM will be required if you use the default arguments. Add --segment SEGMENT
to change size of each split. If you only have 3GB memory, set SEGMENT to 8 (though quality may be worse if this argument is too small). Creating an environment variable PYTORCH_NO_CUDA_MEMORY_CACHING=1
can help users with even smaller RAM such as 2GB (I separated a track that is 4 minutes but only 1.5GB is used), but this would make the separation slower.
If you do not have enough memory on your GPU, simply add -d cpu
to the command line to use the CPU. With Demucs, processing time should be roughly equal to 1.5 times the duration of the track.
Training Demucs
If you want to train (Hybrid) Demucs, please follow the training doc.
MDX Challenge reproduction
In order to reproduce the results from the Track A and Track B submissions, checkout the MDX Hybrid Demucs submission repo.
How to cite
@inproceedings{defossez2021hybrid,
title={Hybrid Spectrogram and Waveform Source Separation},
author={D{\'e}fossez, Alexandre},
booktitle={Proceedings of the ISMIR 2021 Workshop on Music Source Separation},
year={2021}
}
License
Demucs is released under the MIT license as found in the LICENSE file.