From cf4537c5a032d55834665eca14752ce9413bd7db Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexandre=20D=C3=A9fossez?=
 <adefossez@users.noreply.github.com>
Date: Thu, 7 Sep 2023 15:50:06 +0200
Subject: [PATCH] update SISNR doc to make it clear we display minus the SISNR
 (#268)

* doc

* making doc clearer

* line too long
---
 losses/sisnr.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/losses/sisnr.py b/losses/sisnr.py
index 30f1fa1d..a1b8ee03 100644
--- a/losses/sisnr.py
+++ b/losses/sisnr.py
@@ -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