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

SRMR: update note and change default parameters #1872

Merged
merged 11 commits into from
Jul 3, 2023

Conversation

quancs
Copy link
Member

@quancs quancs commented Jul 3, 2023

What does this PR do?

Add note to warn the users that this metric is experimental, and change the default value of max_cf to None to avoid possible misuse.

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

@quancs quancs changed the title SRMR update note and change default parameters SRMR: update note and change default parameters Jul 3, 2023
@quancs quancs marked this pull request as ready for review July 3, 2023 15:43
@Borda Borda added this to the v1.0.0 milestone Jul 3, 2023
@Borda Borda added the documentation Improvements or additions to documentation label Jul 3, 2023
@Borda Borda enabled auto-merge (squash) July 3, 2023 15:57
@codecov
Copy link

codecov bot commented Jul 3, 2023

Codecov Report

Merging #1872 (42319b4) into master (8bf4c94) will decrease coverage by 49%.
The diff coverage is 4%.

Additional details and impacted files
@@           Coverage Diff            @@
##           master   #1872     +/-   ##
========================================
- Coverage      87%     38%    -49%     
========================================
  Files         259     260      +1     
  Lines       14677   14908    +231     
========================================
- Hits        12808    5642   -7166     
- Misses       1869    9266   +7397     

@mergify mergify bot added the ready label Jul 3, 2023
mergify bot and others added 2 commits July 3, 2023 17:45
Co-authored-by: Daniel Stancl <46073029+stancld@users.noreply.github.com>
@Borda Borda merged commit ba34076 into Lightning-AI:master Jul 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants