enhance: add `reduction='none'` to `vif` metric by iamkulbhushansingh · Pull Request #3196 · Lightning-AI/torchmetrics

iamkulbhushansingh · 2025-07-29T21:46:30Z

What does this PR do?

Enhances the Visual Information Fidelity (VIF) metric by adding support for reduction='none'.
This allows users to retrieve per-sample metric values instead of only reduced tensor outputs, bringing the VIF metric in line with other metrics that already support reduction modes.

Fixes #3194

Before submitting

Was this discussed/agreed via a GitHub issue? (not required for minor typos or docs)
Did you read the contributor guidelines?
Did you make sure to update the documentation (docstrings + examples)?
Did you write unit tests for the new feature?

Why is this needed?

reduction='none' enables batch-level debugging, per-sample metric analysis, and flexible custom aggregations.
Maintains API consistency with other TorchMetrics metrics that already support multiple reduction modes.

Additional Context

Added unit tests covering reduction='none' behavior for VIF.
Updated docstring in python file.

Did you have fun?

That was my first Open Source Commit. 💯

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

- Implemented `reduction='none'` option for VIF metric to return per-image scores. - Added unit tests to validate output shape and correctness.

codecov · 2025-07-30T19:58:37Z

Codecov Report

❌ Patch coverage is 68.75000% with 10 lines in your changes missing coverage. Please review.
✅ Project coverage is 68%. Comparing base (5e6081f) to head (f4bf751).
⚠️ Report is 48 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (5e6081f) and HEAD (f4bf751). Click for more details.

HEAD has 4 uploads less than BASE

Flag BASE (5e6081f) HEAD (f4bf751)

gpu 2 0

unittest 2 0

Additional details and impacted files

@@            Coverage Diff            @@
##           master   #3196      +/-   ##
=========================================
- Coverage      99%     68%     -31%     
=========================================
  Files          15     349     +334     
  Lines         195   19891   +19696     
=========================================
+ Hits          194   13617   +13423     
- Misses          1    6274    +6273

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

rittik9 · 2025-07-31T04:26:20Z

Also I think it'll be good if we add same reduction options to functional interface as well for consistency...

Co-authored-by: Rittik Panda <[email protected]>

iamkulbhushansingh

Thanks for corrections.

iamkulbhushansingh · 2025-07-31T06:48:19Z

Adding the reduction option to functional interface.

…ormation_fidelity - Updated functional VIF implementation to support `reduction='none'` - Now returns per-sample VIF scores when reduction is set to 'none' - Retains existing behaviour with 'elementwise_mean' reduction - Improved docstrings and error handling for input validation

rittik9 · 2025-08-03T13:23:58Z


/home/runner/work/torchmetrics/torchmetrics/src/torchmetrics/functional/image/vif.py:docstring of torchmetrics.functional.image.vif.visual_information_fidelity:: WARNING: py:class reference target not found: Tensor containing the VIF score
/home/runner/work/torchmetrics/torchmetrics/src/torchmetrics/functional/image/vif.py:docstring of torchmetrics.functional.image.vif.visual_information_fidelity:: WARNING: py:class reference target not found: s

@iamkulbhushansingh mind checking the above warning?

iamkulbhushansingh · 2025-08-03T13:28:20Z

let me check!

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

Co-authored-by: Nicki Skafte Detlefsen <[email protected]>

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

Co-authored-by: Nicki Skafte Detlefsen <[email protected]>

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

Co-authored-by: Nicki Skafte Detlefsen <[email protected]>

* feat(VIF): add support for reduction='none' * Enhancement(vif): add support for reduction='none' * Apply suggestions from code review --------- Co-authored-by: Kulbhushan Singh <[email protected]> Co-authored-by: Rittik Panda <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Nicki Skafte Detlefsen <[email protected]> Co-authored-by: Jirka Borovec <[email protected]> Co-authored-by: Jirka B <[email protected]> (cherry picked from commit 40a694d)

Kulbhushan Singh added 2 commits July 30, 2025 01:34

feat(VIF): add support for reduction='none'

746c5d2

Enhancement(vif): add support for reduction='none'

af011c8

- Implemented `reduction='none'` option for VIF metric to return per-image scores. - Added unit tests to validate output shape and correctness.

iamkulbhushansingh requested review from Borda, SkafteNicki and justusschock as code owners July 29, 2025 21:46

github-actions Bot added the topic: Image label Jul 29, 2025

rittik9 reviewed Jul 31, 2025

View reviewed changes

Comment thread src/torchmetrics/image/vif.py Outdated

rittik9 reviewed Jul 31, 2025

View reviewed changes

Comment thread src/torchmetrics/image/vif.py Outdated

rittik9 reviewed Jul 31, 2025

View reviewed changes

Comment thread src/torchmetrics/image/vif.py Outdated

rittik9 reviewed Jul 31, 2025

View reviewed changes

Comment thread src/torchmetrics/image/vif.py

iamkulbhushansingh and others added 4 commits July 31, 2025 12:13

Update src/torchmetrics/image/vif.py

72760e0

Co-authored-by: Rittik Panda <[email protected]>

Update src/torchmetrics/image/vif.py

2d2a61e

Co-authored-by: Rittik Panda <[email protected]>

Update src/torchmetrics/image/vif.py

3b463fc

Co-authored-by: Rittik Panda <[email protected]>

Update src/torchmetrics/image/vif.py

df49f7c

Co-authored-by: Rittik Panda <[email protected]>

iamkulbhushansingh commented Jul 31, 2025

View reviewed changes

iamkulbhushansingh requested a review from rittik9 August 1, 2025 09:18

adding tests for vif functional

e134fd8

rittik9 and others added 4 commits August 3, 2025 20:24

Update vif.py

a284ab0

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

c3d0810

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

Update test_vif.py

17d26fa

fix docstring

0a3f0d4

rittik9 approved these changes Aug 3, 2025

View reviewed changes

rittik9 changed the title ~~enh(VIF): add reduction='none' option with tests~~ enhance: add reduction='none' to vif metric Aug 3, 2025

Update CHANGELOG.md

1c23530

iamkulbhushansingh and others added 7 commits August 4, 2025 13:01

Update src/torchmetrics/image/vif.py

867d327

Co-authored-by: Nicki Skafte Detlefsen <[email protected]>

Update src/torchmetrics/image/vif.py

9007df8

Co-authored-by: Nicki Skafte Detlefsen <[email protected]>

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

f26c98e

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

Update src/torchmetrics/image/vif.py

ca1b934

Co-authored-by: Nicki Skafte Detlefsen <[email protected]>

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

7d2d077

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

Update src/torchmetrics/image/vif.py

dc08c28

Co-authored-by: Nicki Skafte Detlefsen <[email protected]>

Apply suggestions from code review

348222e

Borda requested a review from SkafteNicki August 4, 2025 08:38

docstring

155be62

Borda approved these changes Aug 4, 2025

View reviewed changes

Borda enabled auto-merge (squash) August 4, 2025 08:45

Merge branch 'master' into feat/vif-reduction-none

528385c

mergify Bot added the ready label Aug 4, 2025

Merge branch 'master' into feat/vif-reduction-none

73d9040

SkafteNicki approved these changes Aug 5, 2025

View reviewed changes

mergify Bot and others added 10 commits August 6, 2025 09:07

Merge branch 'master' into feat/vif-reduction-none

5bab40e

Merge branch 'master' into feat/vif-reduction-none

d9c2195

Merge branch 'master' into feat/vif-reduction-none

97a0e18

Merge branch 'master' into feat/vif-reduction-none

e3f6eda

Merge branch 'master' into feat/vif-reduction-none

b1a944a

Merge branch 'master' into feat/vif-reduction-none

3c5cd28

Merge branch 'master' into feat/vif-reduction-none

da43388

Merge branch 'master' into feat/vif-reduction-none

8840585

Merge branch 'master' into feat/vif-reduction-none

201b876

Merge branch 'master' into feat/vif-reduction-none

f4bf751

Borda disabled auto-merge August 6, 2025 22:10

Borda merged commit 40a694d into Lightning-AI:master Aug 6, 2025
63 of 64 checks passed

iamkulbhushansingh deleted the feat/vif-reduction-none branch August 15, 2025 10:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

enhance: add `reduction='none'` to `vif` metric#3196

enhance: add `reduction='none'` to `vif` metric#3196
Borda merged 45 commits into
Lightning-AI:masterfrom
iamkulbhushansingh:feat/vif-reduction-none

iamkulbhushansingh commented Jul 29, 2025 •

edited by github-actions Bot

Loading

Uh oh!

codecov Bot commented Jul 30, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rittik9 commented Jul 31, 2025

Uh oh!

Uh oh!

iamkulbhushansingh left a comment

Uh oh!

iamkulbhushansingh commented Jul 31, 2025

Uh oh!

rittik9 commented Aug 3, 2025

Uh oh!

iamkulbhushansingh commented Aug 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

iamkulbhushansingh commented Jul 29, 2025 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Why is this needed?

Additional Context

Did you have fun?

Uh oh!

codecov Bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rittik9 commented Jul 31, 2025

Uh oh!

Uh oh!

iamkulbhushansingh left a comment

Choose a reason for hiding this comment

Uh oh!

iamkulbhushansingh commented Jul 31, 2025

Uh oh!

rittik9 commented Aug 3, 2025

Uh oh!

iamkulbhushansingh commented Aug 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

iamkulbhushansingh commented Jul 29, 2025 •

edited by github-actions Bot

Loading

codecov Bot commented Jul 30, 2025 •

edited

Loading