From 76646b65a0a163d76b138025bb2d4e4a0fe26452 Mon Sep 17 00:00:00 2001 From: Nicki Skafte Detlefsen Date: Tue, 22 Feb 2022 13:08:44 +0100 Subject: [PATCH] docs: Further install instructions for pesq metric (#850) --- torchmetrics/audio/pesq.py | 4 +++- torchmetrics/functional/audio/pesq.py | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/torchmetrics/audio/pesq.py b/torchmetrics/audio/pesq.py index 53cc1666dda..c6939a518ee 100644 --- 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 index cc57e78dfcc..6b23881bdd9 100644 --- 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: