spleeter README

The project's README from github.com/deezer/spleeter. As one markdown file: README.md.

Github actions PyPI - Python Version PyPI version Conda Docker Pulls Open In Colab Gitter chat status

:warning: Spleeter 2.1.0 release introduces some breaking changes, including new CLI option naming for input, and the drop of dedicated GPU package. Please read CHANGELOG for more details.

About

Spleeter is Deezer source separation library with pretrained models written in Python and uses Tensorflow. It makes it easy to train source separation model (assuming you have a dataset of isolated sources), and provides already trained state of the art model for performing various flavour of separation :

2 stems and 4 stems models have high performances on the musdb dataset. Spleeter is also very fast as it can perform separation of audio files to 4 stems 100x faster than real-time when run on a GPU.

We designed Spleeter so you can use it straight from command line as well as directly in your own development pipeline as a Python library. It can be installed with pip or be used with Docker.

Projects and Softwares using Spleeter

Since it's been released, there are multiple forks exposing Spleeter through either a Guided User Interface (GUI) or a standalone free or paying website. Please note that we do not host, maintain or directly support any of these initiatives.

That being said, many cool projects have been built on top of ours. Notably the porting to the Ableton Live ecosystem through the Spleeter 4 Max project.

Spleeter pre-trained models have also been used by professionnal audio softwares. Here's a non-exhaustive list:

🆕 Spleeter is a baseline in the ongoing Music Demixing Challenge!

Spleeter Pro (Commercial version)

Check out our commercial version : Spleeter Pro. Benefit from our expertise for precise audio separation, faster processing speeds, and dedicated professional support.

Quick start

Want to try it out but don't want to install anything ? We have set up a Google Colab.

Ready to dig into it ? In a few lines you can install Spleeter and separate the vocal and accompaniment parts from an example audio file. You need first to install ffmpeg and libsndfile. It can be done on most platform using Conda:

# install dependencies using conda
conda install -c conda-forge ffmpeg libsndfile
# install spleeter with pip
pip install spleeter
# download an example audio file (if you don't have wget, use another tool for downloading)
wget https://github.com/deezer/spleeter/raw/master/audio_example.mp3
# separate the example audio into two components
spleeter separate -p spleeter:2stems -o output audio_example.mp3

:warning: Note that we no longer recommend using conda for installing spleeter.

⚠️ There are known issues with Apple M1 chips, mostly due to TensorFlow compatibility. Until these are fixed, you can use this workaround.

You should get two separated audio files (vocals.wav and accompaniment.wav) in the output/audio_example folder.

For a detailed documentation, please check the repository wiki

Development and Testing

This project is managed using Poetry, to run test suite you can execute the following set of commands:

# Clone spleeter repository
git clone https://github.com/Deezer/spleeter && cd spleeter
# Install poetry
pip install poetry
# Install spleeter dependencies
poetry install
# Run unit test suite
poetry run pytest tests/

Reference

If you use Spleeter in your work, please cite:

@article{spleeter2020,
  doi = {10.21105/joss.02154},
  url = {https://doi.org/10.21105/joss.02154},
  year = {2020},
  publisher = {The Open Journal},
  volume = {5},
  number = {50},
  pages = {2154},
  author = {Romain Hennequin and Anis Khlif and Felix Voituret and Manuel Moussallam},
  title = {Spleeter: a fast and efficient music source separation tool with pre-trained models},
  journal = {Journal of Open Source Software},
  note = {Deezer Research}
}

License

The code of Spleeter is MIT-licensed.

Disclaimer

If you plan to use Spleeter on copyrighted material, make sure you get proper authorization from right owners beforehand.

Troubleshooting

Spleeter is a complex piece of software and although we continously try to improve and test it you may encounter unexpected issues running it. If that's the case please check the FAQ page first as well as the list of currently open issues

Windows users

It appears that sometimes the shortcut command spleeter does not work properly on windows. This is a known issue that we will hopefully fix soon. In the meantime replace spleeter separate by python -m spleeter separate in command line and it should work.

Contributing

If you would like to participate in the development of Spleeter you are more than welcome to do so. Don't hesitate to throw us a pull request and we'll do our best to examine it quickly. Please check out our guidelines first.

Note

This repository include a demo audio file audio_example.mp3 which is an excerpt from Slow Motion Dream by Steven M Bryant (c) copyright 2011 Licensed under a Creative Commons Attribution (3.0) license Ft: CSoul,Alex Beroza & Robert Siekawitch

spleeter (deezer/spleeter)

Searching Database…

28.5K ·GitHub
Что это такое?Spleeter — это библиотека разделения источников звука от Deezer: предобученные модели, написанные на Python с использованием TensorFlow, которые разбивают песню на дорожки — вокал, ударные, бас, фортепиано и другие. Поставляются варианты на 2, 4 и 5 дорожек, а модели на 2 и 4 дорожки показывают высокие результаты на датасете musdb.
Это утилита командной строки или библиотека для Python?И то, и другое. Она рассчитана на использование прямо из командной строки, а также напрямую в вашем рабочем процессе разработки в виде библиотеки для Python. Установить её можно через pip или запустить через Docker.
Как её запустить?Сначала установите ffmpeg и libsndfile — Conda сделает это на большинстве платформ — затем установите Spleeter через pip или используйте Docker. Если хотите попробовать, ничего не устанавливая, есть официальный Google Colab.
Есть ли проблемы на каких-то платформах?Да, немного. Есть известные проблемы с чипами Apple M1, в основном из-за совместимости с TensorFlow, — в README предложено обходное решение. В Windows команда spleeter иногда не срабатывает — используйте вместо неё python -m spleeter separate.
Она полностью бесплатна или есть платная версия?Код распространяется по лицензии MIT, так что сама библиотека бесплатна. Deezer также предлагает Spleeter Pro — платную коммерческую версию с более точным разделением, быстрой обработкой и отдельной профессиональной поддержкой.
Есть ли графический интерфейс, или всё только через командную строку?Сам Spleeter — это только командная строка и библиотека для Python. Несколько сторонних форков оборачивают его в графические интерфейсы или в бесплатные и платные сайты, но Deezer не размещает, не поддерживает и никак не обслуживает эти проекты.
Какие известные аудиопродукты построены на Spleeter?Его предобученные модели работают в Music Rebalance от iZotope в RX 8, функции Unmix в SpectralLayers 7, Acon Digital Acoustica 7, изоляции дорожек в VirtualDJ и приложениях NeuralMix и djayPRO от Algoriddim. Spleeter 4 Max также переносит его в экосистему Ableton Live.
Могу ли я обучить свою модель разделения вместо готовых?Да — она задумана так, чтобы обучение было простым, если у вас есть датасет с изолированными источниками. Большинству пользователей хватит встроенных предобученных моделей: они на уровне лучших в своём классе и служат базовым ориентиром в Music Demixing Challenge.
Можно ли загружать в неё песни, защищённые авторским правом?Лицензия MIT распространяется на код, а не на контент, который вы обрабатываете. В README предупреждают: если вы планируете использовать Spleeter на материалах, защищённых авторским правом, заранее следует получить надлежащее разрешение от правообладателей.
Creator
deezer
Size
9.4 MB
Stars
28.5K
Age
7y
Commits · 90 Days