docs: Further install instructions for pesq metric (#850)

Lightning-AI · Feb 22, 2022 · 76646b6 · 76646b6
1 parent eb1c6cf
commit 76646b6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/torchmetrics/audio/pesq.py b/torchmetrics/audio/pesq.py
@@ -29,7 +29,9 @@ class PerceptualEvaluationSpeechQuality(Metric):
     to perform the metric calculation.
 
     .. note:: using this metrics requires you to have ``pesq`` install. Either install as ``pip install
-        torchmetrics[audio]`` or ``pip install pesq``
+        torchmetrics[audio]`` or ``pip install pesq``. Note that ``pesq`` will compile with your currently
+        installed version of numpy, meaning that if you upgrade numpy at some point in the future you will
+        most likely have to reinstall ``pesq``.
 
     Forward accepts
 

diff --git a/torchmetrics/functional/audio/pesq.py b/torchmetrics/functional/audio/pesq.py
@@ -36,7 +36,9 @@ def perceptual_evaluation_speech_quality(
     to perform the metric calculation.
 
     .. note:: using this metrics requires you to have ``pesq`` install. Either install as ``pip install
-        torchmetrics[audio]`` or ``pip install pesq``
+        torchmetrics[audio]`` or ``pip install pesq``. Note that ``pesq`` will compile with your currently
+        installed version of numpy, meaning that if you upgrade numpy at some point in the future you will
+        most likely have to reinstall ``pesq``.
 
     Args:
         preds: