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.

Sign up for GitHub

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

Jump to bottom

Add MutualInformation Metric #3230

Merged
merged 24 commits into from
Apr 8, 2024
Merged

Add MutualInformation Metric #3230

merged 24 commits into from
Apr 8, 2024

Conversation

kzkadc
Copy link
Contributor

@kzkadc 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)

@github-actions github-actions bot added docs module: metrics Metrics module labels Apr 3, 2024
@vfdev-5
Copy link
Collaborator

vfdev-5 commented Apr 4, 2024

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

vfdev-5
vfdev-5 reviewed Apr 8, 2024
View reviewed changes
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

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

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
vfdev-5
vfdev-5 approved these changes Apr 8, 2024
View reviewed changes
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

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

Thanks @kzkadc, looks good to me!

@vfdev-5 vfdev-5 enabled auto-merge (squash) April 8, 2024 16:29
@vfdev-5 vfdev-5 merged commit 2c79b7e into pytorch:master Apr 8, 2024
18 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vfdev-5 vfdev-5 vfdev-5 approved these changes

Assignees
No one assigned
Labels
docs module: metrics Metrics module
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kzkadc @vfdev-5