audio metrics: SNR, SI_SDR, SI_SNR #292

quancs · 2021-06-13T05:50:56Z

Before submitting

Was this discussed/approved 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?

What does this PR do?

Fixes #291

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 🙃

pep8speaks · 2021-06-13T05:50:59Z

Hello @quancs! Thanks for updating this PR.

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-06-22 17:06:58 UTC

for more information, see https://pre-commit.ci

codecov · 2021-06-13T05:52:18Z

Codecov Report

Merging #292 (fec3598) into master (a75445b) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #292   +/-   ##
=======================================
  Coverage   96.41%   96.42%           
=======================================
  Files          98      106    +8     
  Lines        3350     3442   +92     
=======================================
+ Hits         3230     3319   +89     
- Misses        120      123    +3

Flag	Coverage Δ
Linux	`75.82% <94.89%> (+0.55%)`	⬆️
Windows	`75.82% <94.89%> (+0.55%)`	⬆️
cpu	`75.82% <94.89%> (-19.76%)`	⬇️
gpu	`96.42% <100.00%> (+0.03%)`	⬆️
macOS	`75.82% <94.89%> (-19.76%)`	⬇️
pytest	`96.42% <100.00%> (+<0.01%)`	⬆️
python3.6	`?`
python3.8	`?`
torch1.3.1	`?`
torch1.4.0	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
torchmetrics/__init__.py	`100.00% <100.00%> (ø)`
torchmetrics/audio/__init__.py	`100.00% <100.00%> (ø)`
torchmetrics/audio/si_sdr.py	`100.00% <100.00%> (ø)`
torchmetrics/audio/si_snr.py	`100.00% <100.00%> (ø)`
torchmetrics/audio/snr.py	`100.00% <100.00%> (ø)`
torchmetrics/functional/__init__.py	`100.00% <100.00%> (ø)`
torchmetrics/functional/audio/__init__.py	`100.00% <100.00%> (ø)`
torchmetrics/functional/audio/si_sdr.py	`100.00% <100.00%> (ø)`
torchmetrics/functional/audio/si_snr.py	`100.00% <100.00%> (ø)`
torchmetrics/functional/audio/snr.py	`100.00% <100.00%> (ø)`
... and 11 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a75445b...fec3598. Read the comment docs.

…dio-dev

Borda

Very nice addition!
mind also add Mudule version and docs 🐰

quancs · 2021-06-13T08:29:50Z

Very nice addition!
mind also add Mudule version and docs 🐰

OK. Can you tell me how and where to add Mudule version and docs?

Borda · 2021-06-13T08:39:56Z

Can you tell me how and where to add Module version and docs?

sure, please check adding this metric as template/example #210

SkafteNicki

Great start. Some of the comments that I made to the scale-invariant signal-to-distortion ratio metric also applies to the other two (the inclusion of the EPS parameter and the naming of the estimate tensor).

torchmetrics/functional/audio/si_sdr.py

torchmetrics/functional/audio/si_snr.py

torchmetrics/functional/audio/snr.py

Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>

for more information, see https://pre-commit.ci

torchmetrics/functional/audio/si_sdr.py

Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>

* add _apply_sync to nn.Metric * move to context manager * add sync * add restore_cache * add a sync test * Update torchmetrics/metric.py Co-authored-by: Nicki Skafte <skaftenicki@gmail.com> * remove _update_signature * Apply suggestions from code review Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com> * resolve failing test Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Nicki Skafte <skaftenicki@gmail.com> Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com> Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>

updates: - [github.com/PyCQA/isort: 5.8.0 → 5.9.1](PyCQA/isort@5.8.0...5.9.1) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* implementation * parameter testing * fix test * implementation * update to torch fidelity 0.3.0 * changelog * docs * Apply suggestions from code review Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com> * add test * update * fix tests * typing * fix typing * fix bus error * Apply suggestions from code review Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com> Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

-u root cuda 10.2 whoami

…dio-dev

add snr, si_sdr, si_snr

74b1b9b

quancs requested review from ananyahjha93, Borda, justusschock, SkafteNicki and tchaton as code owners June 13, 2021 05:50

[pre-commit.ci] auto fixes from pre-commit.com hooks

a653056

for more information, see https://pre-commit.ci

quancs added 2 commits June 13, 2021 15:31

format

70f82b4

Merge branch 'audio-dev' of https://github.com/quancs/metrics into au…

9e30f76

…dio-dev

Borda added enhancement New feature or request New metric labels Jun 13, 2021

Borda reviewed Jun 13, 2021

View reviewed changes

Borda changed the title ~~add snr, si_sdr, si_snr~~ audio metrics: SNR, SI_SDR, SI_SNR Jun 13, 2021

add noqa: F401 to __init__.py

0331dd0

SkafteNicki reviewed Jun 13, 2021

View reviewed changes

quancs and others added 10 commits June 13, 2021 21:31

Update torchmetrics/functional/audio/si_sdr.py

fcc827e

Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>

Update torchmetrics/functional/audio/si_sdr.py

ef19181

Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>

Update torchmetrics/functional/audio/si_sdr.py

80e6c53

Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>

Update torchmetrics/functional/audio/si_snr.py

32c0ce0

Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>

Update torchmetrics/functional/audio/snr.py

489dba0

Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>

[pre-commit.ci] auto fixes from pre-commit.com hooks

249d848

for more information, see https://pre-commit.ci

remove types in doc, change estimate to preds, remove EPS

017ba3a

[pre-commit.ci] auto fixes from pre-commit.com hooks

c8aa372

for more information, see https://pre-commit.ci

update functional.rst

c82a094

update CHANGELOG.md

a33ff6e

SkafteNicki reviewed Jun 21, 2021

View reviewed changes

torchmetrics/functional/audio/si_sdr.py Outdated Show resolved Hide resolved

Update torchmetrics/functional/audio/si_sdr.py

3eb3d65

Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>

quancs requested review from Borda and justusschock June 21, 2021 19:42

mergify bot removed the has conflicts label Jun 22, 2021

Borda approved these changes Jun 22, 2021

View reviewed changes

Borda enabled auto-merge (squash) June 22, 2021 12:07

auto-merge was automatically disabled June 22, 2021 13:52
Head branch was pushed to by a user without write access

tchaton and others added 9 commits June 22, 2021 18:33

v0.4.0rc0

3408927

[pre-commit.ci] pre-commit suggestions (#306)

267380d

updates: - [github.com/PyCQA/isort: 5.8.0 → 5.9.1](PyCQA/isort@5.8.0...5.9.1) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Apply suggestions from code review

e7753e1

SRMRpy

e82bc96

pesq

bb045c9

gcc

70687f1

comment

050bb7b

-u root cuda 10.2 whoami

mergify bot added the has conflicts label Jun 22, 2021

Borda and others added 2 commits June 22, 2021 18:47

env

de034a3

Merge branch 'master' into audio-dev

2fa46af

mergify bot removed the has conflicts label Jun 22, 2021

Borda enabled auto-merge (squash) June 22, 2021 16:53

Borda added 3 commits June 22, 2021 18:58

env

cda3c6b

Merge branch 'audio-dev' of https://github.com/quancs/metrics into au…

47e0cf8

…dio-dev

env

fec3598

Borda merged commit fe03f3a into Lightning-AI:master Jun 22, 2021

quancs deleted the audio-dev branch August 5, 2021 07:56

Borda added the topic: Audio label Aug 25, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

audio metrics: SNR, SI_SDR, SI_SNR #292

audio metrics: SNR, SI_SDR, SI_SNR #292

quancs commented Jun 13, 2021 •

edited

Loading

pep8speaks commented Jun 13, 2021 •

edited

Loading

codecov bot commented Jun 13, 2021 •

edited

Loading

Borda left a comment

quancs commented Jun 13, 2021

Borda commented Jun 13, 2021

SkafteNicki left a comment

audio metrics: SNR, SI_SDR, SI_SNR #292

audio metrics: SNR, SI_SDR, SI_SNR #292

Conversation

quancs commented Jun 13, 2021 • edited Loading

Before submitting

What does this PR do?

PR review

Did you have fun?

pep8speaks commented Jun 13, 2021 • edited Loading

Comment last updated at 2021-06-22 17:06:58 UTC

codecov bot commented Jun 13, 2021 • edited Loading

Codecov Report

Borda left a comment

Choose a reason for hiding this comment

quancs commented Jun 13, 2021

Borda commented Jun 13, 2021

SkafteNicki left a comment

Choose a reason for hiding this comment

quancs commented Jun 13, 2021 •

edited

Loading

pep8speaks commented Jun 13, 2021 •

edited

Loading

codecov bot commented Jun 13, 2021 •

edited

Loading