Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix pesq docs #2114

Merged
merged 4 commits into from
Sep 27, 2023
Merged

fix pesq docs #2114

merged 4 commits into from
Sep 27, 2023

Conversation

pme0
Copy link
Contributor

@pme0 pme0 commented Sep 26, 2023

What does this PR do?

Fixes #2095

PESQ (torchmetrics.audio.pesq.PerceptualEvaluationSpeechQuality) docs incorrectly state that a tensor of pesq values is returned. This PR:

  • corrects this inconsistency between docs and implementation, namely that forward and compute return metric value reduced across the batch, instead of a tensor of metrics values for each sample;
  • adds a note guiding the user to the functional version of PESQ (torchmetrics.functional.audio.pesq.perceptual_evaluation_speech_quality) if a tensor of metrics values for each sample is required;
Before submitting
  • Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?
PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.


📚 Documentation preview 📚: https://torchmetrics--2114.org.readthedocs.build/en/2114/

@codecov
Copy link

codecov bot commented Sep 26, 2023

Codecov Report

Merging #2114 (f2fef22) into master (1ddacab) will decrease coverage by 51%.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff            @@
##           master   #2114     +/-   ##
========================================
- Coverage      87%     36%    -51%     
========================================
  Files         293     293             
  Lines       16299   16299             
========================================
- Hits        14177    5837   -8340     
- Misses       2122   10462   +8340     

@mergify mergify bot added the ready label Sep 27, 2023
@Borda Borda merged commit e5b1893 into Lightning-AI:master Sep 27, 2023
64 of 66 checks passed
Borda pushed a commit that referenced this pull request Nov 30, 2023
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
(cherry picked from commit e5b1893)
Borda pushed a commit that referenced this pull request Dec 1, 2023
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
(cherry picked from commit e5b1893)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistent docs and code output for PerceptualEvaluationSpeechQuality
3 participants