Skip to content

Commit

Permalink
removung unnessary documations
Browse files Browse the repository at this point in the history
  • Loading branch information
Fabian-Robert Stöter committed Jun 13, 2016
1 parent 12d883b commit b1ca6b1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 28 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ parallel --bar 'DSD_ID={0} python main.py' ::: {0..99}
## Compute the bss_eval measures

The official SISEC evaluation relies on _MATLAB_ because currently there does not exist a [bss_eval](http://bass-db.gforge.inria.fr/bss_eval/) implementation for python which produces identical results.
Therefore please run ```dsd100_eval_only.m``` from the [dsdtools Matlab scripts](https://github.com/faroit/dsd100mat) after you have processed and saved your estimates with _dsdtools_.
Therefore please run ```dsd100_eval_only.m``` from the [DSD100 Matlab scripts](https://github.com/faroit/dsd100mat) after you have processed and saved your estimates with _dsdtools_.

## Full code Example

Expand Down
30 changes: 3 additions & 27 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -162,36 +162,12 @@ The official SISEC evaluation relies on *MATLAB* because currently there
does not exist a
`bss\_eval <http://bass-db.gforge.inria.fr/bss_eval/>`__ implementation
for python which produces indentical results. Therefore please run
``dsdtools_only_eval.m`` from the `dsdtools Matlab
scripts <https://github.com/faroit/dsdtoolsmat>`__ after you have
``dsd100_eval_only.m`` from the `DSD100 Matlab
scripts <https://github.com/faroit/dsd100mat>`__ after you have
processed and saved your estimates with *dsdtoolspy*.


Evaluation in python
^^^^^^^^^^^^^^^^^^^^

.. warning:: Warning, this is not supported yet

If you really don't want to start MATLAB you can run the bss\_eval from
python with the help of
`matlab\_wrapper <https://github.com/mrkrd/matlab_wrapper>`__. For
convenience this package already has implemented the MATLAB evaluation
functions but does not write them to mat files yet. We offer several
optional methods to parse the dsdtools:

.. code:: python
# Evaluate the results using matlab_wrapper and save the estimates to disk
dsd.run(my_function, save=True, evaluate=True)
# Evaluate the results using matlab_wrapper but do not save the estimates to disk
dsd.run(my_function, save=False, evaluate=True)
# Just evaluate the user_estimates folder when the estimates have already been saved to disk
# this equivalent to the MATLAB dsdtools_only_eval.m function
dsd.run(save=False, evaluate=True)
# or simply which is the same as as last line
dsd.evaluate()
# Only pass the tracks to my_function. Ignore the results. Useful for statistics
dsd.run(my_function, save=False, evaluate=False)
.. warning:: Evaluation in python is not supported yet

0 comments on commit b1ca6b1

Please sign in to comment.