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

Mutual Information Score #2008

Merged
merged 34 commits into from
Aug 25, 2023
Merged

Conversation

matsumotosan
Copy link
Member

@matsumotosan matsumotosan commented Aug 21, 2023

What does this PR do?

Fixes part of #2003

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--2008.org.readthedocs.build/en/2008/

@matsumotosan matsumotosan mentioned this pull request Aug 21, 2023
13 tasks
Copy link
Member

@SkafteNicki SkafteNicki left a comment

Choose a reason for hiding this comment

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

The PR is already looking very good. I think we just need a bit of refactoring, because this introduces some functions that can benefit other clustering metrics.

src/torchmetrics/clustering/mutual_info_score.py Outdated Show resolved Hide resolved
src/torchmetrics/clustering/mutual_info_score.py Outdated Show resolved Hide resolved
src/torchmetrics/clustering/mutual_info_score.py Outdated Show resolved Hide resolved
docs/source/clustering/mutual_info_score.rst Outdated Show resolved Hide resolved
@SkafteNicki SkafteNicki added this to the v1.2.0 milestone Aug 22, 2023
@SkafteNicki SkafteNicki added enhancement New feature or request New metric labels Aug 22, 2023
@SkafteNicki SkafteNicki marked this pull request as ready for review August 25, 2023 13:13
Copy link
Member

@SkafteNicki SkafteNicki left a comment

Choose a reason for hiding this comment

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

Good job @matsumotosan.
Just fixes two smaller issues, but PR LGTM :]

@codecov
Copy link

codecov bot commented Aug 25, 2023

Codecov Report

Merging #2008 (51d3f2a) into master (5ed0f83) will decrease coverage by 52%.
The diff coverage is 95%.

Additional details and impacted files
@@           Coverage Diff            @@
##           master   #2008     +/-   ##
========================================
- Coverage      87%     35%    -52%     
========================================
  Files         270     275      +5     
  Lines       15572   15649     +77     
========================================
- Hits        13475    5469   -8006     
- Misses       2097   10180   +8083     

@mergify mergify bot added the ready label Aug 25, 2023
@Borda Borda enabled auto-merge (squash) August 25, 2023 14:43
@Borda Borda merged commit 2780a32 into Lightning-AI:master Aug 25, 2023
@matsumotosan matsumotosan deleted the 2003-mutual-info-score branch August 26, 2023 13:34
matsumotosan added a commit to matsumotosan/metrics that referenced this pull request Sep 19, 2023
Co-authored-by: Nicki Skafte Detlefsen <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants