Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
Borda authored Sep 26, 2023
1 parent 90655a9 commit f2fef22
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/torchmetrics/audio/pesq.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ class PerceptualEvaluationSpeechQuality(Metric):
installed version of numpy, meaning that if you upgrade numpy at some point in the future you will
most likely have to reinstall ``pesq``.
.. note: the ``forward`` and ``compute`` methods in this class return a single (reduced) PESQ value
.. note:: the ``forward`` and ``compute`` methods in this class return a single (reduced) PESQ value
for a batch. To obtain a PESQ value for each sample, you may use the functional counterpart in
``torchmetrics.functional.audio.pesq.perceptual_evaluation_speech_quality()``.
:func:`~torchmetrics.functional.audio.pesq.perceptual_evaluation_speech_quality`.
Args:
fs: sampling frequency, should be 16000 or 8000 (Hz)
Expand Down

0 comments on commit f2fef22

Please sign in to comment.