New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

Add MutualInformation Metric #3230

Merged

vfdev-5 merged 24 commits into pytorch:master from kzkadc:mutual-information

Apr 8, 2024

Contributor

kzkadc commented Apr 3, 2024

Description: added MutualInformation metric, which is often used in representation learning.

It measures the mutual information between input and output for classification models.

Check list:

New tests are added (if a new feature is added)
New doc strings: description and/or example code are in RST format
Documentation is updated (if required)

kzkadc added 14 commits

March 23, 2024 22:50


          add MutualInformationMetric

2e0d9fd


          update test for MutualInformation metric

c6cf3e5


          format code for MutualInformation Metric

06b218c


          Merge branch 'master' into mutual-information

896e92c


          update test for MutualInformation metric

b85fbd1


          Merge branch 'master' into mutual-information

e59e05b


          Merge branch 'master' into mutual-information

78bdbb2


          update test

40e9e67


          update docstring

f7d3a41


          fix device compatibility

72e1664


          fix test_accumulator_device for MutualInformation metric

3f5c28d


          Merge branch 'master' into mutual-information

035e32e


          Merge branch 'master' into mutual-information

b274037


          update doc

61669ee

github-actions bot added docs module: metrics labels


          modify docstring

51676eb

vfdev-5 reviewed

View reviewed changes

ignite/metrics/mutual_information.py Show resolved Hide resolved

vfdev-5 reviewed

View reviewed changes

tests/ignite/metrics/test_mutual_information.py Show resolved Hide resolved

Collaborator

vfdev-5 commented Apr 4, 2024

@kzkadc thanks for the PR adding more metrics !
I left few comments to check

vfdev-5 reviewed

View reviewed changes

ignite/metrics/mutual_information.py Outdated Show resolved Hide resolved

kzkadc added 3 commits

April 4, 2024 21:06


          modify formula of docstring

6ededec


          update formula of docstring

ba3e78f


          update formula of docstring

73b7928

vfdev-5 reviewed

View reviewed changes

ignite/metrics/mutual_information.py Outdated Show resolved Hide resolved

vfdev-5 reviewed

View reviewed changes

ignite/metrics/mutual_information.py Show resolved Hide resolved

kzkadc added 3 commits

April 5, 2024 21:23


          remove unused import

c4bc88a


          add reference

d124752


          commonalize redundant code

366d854

vfdev-5 reviewed

View reviewed changes

Collaborator

vfdev-5 left a comment

Thanks for the update @kzkadc !
I left few other comments on how to use reinit__is_reduced decorator

ignite/metrics/entropy.py Outdated Show resolved Hide resolved

ignite/metrics/mutual_information.py Outdated Show resolved Hide resolved

kzkadc added 2 commits

April 8, 2024 22:01


          modify decorator

d6b2ee6


          add a comment

b1cc792

vfdev-5 reviewed

View reviewed changes

ignite/metrics/mutual_information.py Outdated Show resolved Hide resolved


          fix decorator

a23b435

vfdev-5 approved these changes

View reviewed changes

Collaborator

vfdev-5 left a comment

Thanks @kzkadc, looks good to me!

vfdev-5 enabled auto-merge (squash)

April 8, 2024 16:29

vfdev-5 merged commit 2c79b7e into pytorch:master

18 of 20 checks passed

# for free to join this conversation on GitHub. Already have an account? # to comment

Labels

docs module: metrics