Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
faradox committed Feb 29, 2024
1 parent d2b4caa commit 291512c
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,13 @@ Polymath makes it effortless to combine elements from different tracks to create

## How does it work?

- Music Source Separation is performed with the [Nendo Demucs Stemification Plugin](https://github.com/okio-ai/nendo_plugin_stemify_demucs)
- Music information retrieval is performed with the [Nendo Core Classification Plugin](https://github.com/okio-ai/nendo_plugin_classify_core)
- Music Quantization is performed with the [Nendo Core Quantization Plugin](https://github.com/okio-ai/nendo_plugin_quantize_core)
- Loopification is performed with [Nendo Loopify Plugin](https://github.com/okio-ai/nendo_plugin_loopify)
- Import tracks from youtube or directly from your google drive
- Process selected (or all) tracks with a configurable selection of nendo plugins:
- Apply the [classification plugin](https://github.com/okio-ai/nendo-plugin-classify-core) to compute _volume_, _tempo_ (bpm), _key_, _intensity_, _frequency_, and _loudness_ for each track
- Apply the [stemification plugin](https://github.com/okio-ai/nendo-plugin-stemify-demucs) to separate each track into four source signals: _vocals_, _drum_, _bass_, and _other_
- Apply the [quantization plugin](https://github.com/okio-ai/nendo-plugin-quantize-core) to quantize each track to a specified target _bpm_
- Apply the [loopification plugin](https://github.com/okio-ai/nendo-plugin-loopify) to automatically detect and extract loops from each sample
- Export the results of the processing with informative file names to your google drive in _wav_, _mp3_ or _ogg_ format.

## Community

Expand All @@ -43,6 +46,7 @@ Furthermore, the following software packages need to be installed in your system
You need python version `>=3.8` and `<=3.10`. From your terminal run:

```bash
pip install git+https://github.com/CPJKU/madmom.git@0551aa8
git clone https://github.com/samim23/polymath
cd polymath
pip install -r requirements.txt
Expand All @@ -51,14 +55,6 @@ pip uninstall -y essentia essentia-tensorflow && pip install essentia-tensorflow

The last line is a fix that's needed to avoid a dependency conflict among the plugins.

## Troubleshooting

If you run into an issue with the `madmom` module missing (most likely because you've installed polymath by means of a `requirements.txt` file pointing to this github repo as part of another python app), install it manually:

```bash
pip install git+https://github.com/CPJKU/madmom.git@0551aa8
```

## GPU support

Most of the libraries polymath uses come with native GPU support through cuda. Please follow the steps on https://www.tensorflow.org/install/pip to setup tensorflow for use with cuda. If you have followed these steps, tensorflow and torch will both automatically pick up the GPU and use it. This only applied to native setups, for dockerized deployments (see next section), gpu support is forthcoming
Expand Down

0 comments on commit 291512c

Please sign in to comment.