Skip to content

Commit

Permalink
Remove unnecessary fork description in README
Browse files Browse the repository at this point in the history
  • Loading branch information
sevagh committed Aug 19, 2021
1 parent 6269809 commit d527421
Showing 1 changed file with 0 additions and 7 deletions.
7 changes: 0 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,6 @@

A python package to evaluate source separation results using the [MUSDB18](https://sigsep.github.io/musdb) dataset. This package was part of the [MUS task](https://sisec.inria.fr/home/2018-professionally-produced-music-recordings/) of the [Signal Separation Evaluation Campaign (SISEC)](https://sisec.inria.fr/).

### Note on the sevagh fork

My fork adds considerable speedups by using cupy for offloading the fft, ifft, and linalg executions of BSSv4 to the user's NVIDIA GPU. However, this has several downsides:
* Switching to using GPU arithmetic and float32 changes output values due to numerical precision differences
* Managing memory is not straightforward, often requiring the user to disable and re-enable the cupy fft cache between runs
* Installing GPU libraries is a burden on end users, so it's a bigger conversation to merge such a requirement upstream

### BSSEval v4

The BSSEval metrics, as implemented in the [MATLAB toolboxes](http://bass-db.gforge.inria.fr/bss_eval/) and their re-implementation in [mir_eval](http://craffel.github.io/mir_eval/#module-mir_eval.separation) are widely used in the audio separation literature. One particularity of BSSEval is to compute the metrics after optimally matching the estimates to the true sources through linear distortion filters. This allows the criteria to be robust to some linear mismatches. Apart from the optional evaluation for all possible permutations of the sources, this matching is the reason for most of the computation cost of BSSEval, especially considering it is done for each evaluation window when the metrics are computed on a framewise basis.
Expand Down

0 comments on commit d527421

Please sign in to comment.