diff --git a/CHANGELOG.md b/CHANGELOG.md index 14eb688..6142016 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ library build backend. * `-i` option is now deprecated and replaced by traditional CLI input argument listing * Project is now built using Poetry * Project requires code formatting using Black and iSort +* Dedicated GPU package `spleeter-gpu` is not supported anymore, `spleeter` package will support both CPU and GPU hardware ### API changes: diff --git a/README.md b/README.md index db6915e..c77362d 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ [![Github actions](https://github.com/deezer/spleeter/workflows/pytest/badge.svg)](https://github.com/deezer/spleeter/actions) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/spleeter) [![PyPI version](https://badge.fury.io/py/spleeter.svg)](https://badge.fury.io/py/spleeter) [![Conda](https://img.shields.io/conda/vn/conda-forge/spleeter)](https://anaconda.org/conda-forge/spleeter) [![Docker Pulls](https://img.shields.io/docker/pulls/researchdeezer/spleeter)](https://hub.docker.com/r/researchdeezer/spleeter) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deezer/spleeter/blob/master/spleeter.ipynb) [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/spleeter/community) [![status](https://joss.theoj.org/papers/259e5efe669945a343bad6eccb89018b/status.svg)](https://joss.theoj.org/papers/259e5efe669945a343bad6eccb89018b) +> :warning: [Spleeter 2.1.0](https://pypi.org/project/spleeter/) release introduces some breaking changes, including new CLI option naming for input, and the drop +> of dedicated GPU package. Please read [CHANGELOG](CHANGELOG.md) for more details. + ## About **Spleeter** is [Deezer](https://www.deezer.com/) source separation library with pretrained models @@ -46,7 +49,7 @@ conda install -c conda-forge 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 -i audio_example.mp3 -p spleeter:2stems -o output +spleeter separate -p spleeter:2stems -o output audio_example.mp3 ``` You should get two separated audio files (`vocals.wav` and `accompaniment.wav`) in the `output/audio_example` folder. @@ -55,13 +58,18 @@ For a detailed documentation, please check the [repository wiki](https://github. ## Development and Testing -The following set of commands will clone this repository, create a virtual environment provisioned with the dependencies and run the tests (will take a few minutes): +This project is managed using [Poetry](https://python-poetry.org/docs/basic-usage/), to run test suite you +can execute the following set of commands: ```bash +# Clone spleeter repository git clone https://github.com/Deezer/spleeter && cd spleeter -python -m venv spleeterenv && source spleeterenv/bin/activate -pip install . && pip install pytest pytest-xdist -make test +# Install poetry +pip install poetry +# Install spleeter dependencies +poetry install +# Run unit test suite +poetry run pytest tests/ ``` ## Reference