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

Add speech-to-reverberation modulation energy ratio (SRMR) metric #1792

Merged
merged 83 commits into from Jun 29, 2023

Conversation

quancs
Copy link
Member

@quancs quancs commented May 16, 2023

What does this PR do?

Add SRMR metric

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.

Did you have fun?

Make sure you had fun coding 🙃


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

@SkafteNicki SkafteNicki added this to the future milestone May 22, 2023
@SkafteNicki SkafteNicki added enhancement New feature or request New metric labels May 22, 2023
@SkafteNicki SkafteNicki added this to In progress in Audio via automation May 23, 2023
@mergify mergify bot added the ready label Jun 19, 2023
@Borda Borda requested a review from vkuznetsovgn June 29, 2023 06:58
@@ -6,3 +6,4 @@ mir-eval >=0.6, <=0.7
speechmetrics @ git+https://github.com/aliutkus/speechmetrics
fast-bss-eval >=0.1.0, <0.1.5
torch_complex <=0.4.3 # needed for fast-bss-eval
srmrpy @ git+https://github.com/jfsantos/SRMRpy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note this wont be installed with pypi

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turned out this repo is not tested, so we shall not rely with parity on their numbers
ref: jfsantos/SRMRpy#15

@mergify mergify bot removed the ready label Jun 29, 2023
src/torchmetrics/audio/srmr.py Outdated Show resolved Hide resolved
Audio automation moved this from In progress to Reviewer approved Jun 29, 2023
Borda and others added 2 commits June 29, 2023 10:49
Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
@mergify mergify bot added the ready label Jun 29, 2023
@Borda
Copy link
Member

Borda commented Jun 29, 2023

for the record of detly/gammatone#16 (comment)

@SkafteNicki SkafteNicki merged commit 372f22e into Lightning-AI:master Jun 29, 2023
63 checks passed
Audio automation moved this from Reviewer approved to Done Jun 29, 2023
@quancs quancs deleted the srmr branch June 29, 2023 11:48
@Borda
Copy link
Member

Borda commented Jun 29, 2023

@SkafteNicki @quancs have you checked the testing of the added package?
ref: jfsantos/SRMRpy#15 (comment)

@quancs
Copy link
Member Author

quancs commented Jun 30, 2023

@SkafteNicki @quancs have you checked the testing of the added package? ref: jfsantos/SRMRpy#15 (comment)

I tested just now. but the tests didn't get passed.

@Borda
Copy link
Member

Borda commented Jul 3, 2023

@quancs lets add a note that this metric is experimental as we do not have any parity or own reference values to test with

@quancs
Copy link
Member Author

quancs commented Jul 3, 2023

@quancs lets add a note that this metric is experimental as we do not have any parity or own reference values to test with

OK.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Audio
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants