Skip to content

Commit

Permalink
update SISNR doc to make it clear we display minus the SISNR (faceboo…
Browse files Browse the repository at this point in the history
…kresearch#268)

* doc

* making doc clearer

* line too long
  • Loading branch information
adefossez authored Sep 7, 2023
1 parent 4a4578a commit cf4537c
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions losses/sisnr.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ class SISNR(nn.Module):
Input should be [B, C, T], output is scalar.
..Warning:: This function returns the opposite of the SI-SNR (e.g. `-1 * regular_SI_SNR`).
Consequently, lower scores are better in terms of reconstruction quality,
in particular, it should be negative if training goes well. This done this way so
that this module can also be used as a loss function for training model.
Args:
sample_rate (int): Sample rate.
segment (float or None): Evaluate on chunks of that many seconds. If None, evaluate on
Expand Down

0 comments on commit cf4537c

Please sign in to comment.