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

Improvements to docs on custom implementations #2061

Merged
merged 18 commits into from
Sep 15, 2023
Merged

Improvements to docs on custom implementations #2061

merged 18 commits into from
Sep 15, 2023

Conversation

SkafteNicki
Copy link
Member

@SkafteNicki SkafteNicki commented Sep 6, 2023

What does this PR do?

Fixes #2005
Trying to give the documentation on creating custom implementation an update.
As mentioned in the issue, some details especially regarding list metric states are missing.
Also did a bit of an update to the utilities section.

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

@SkafteNicki SkafteNicki added the documentation Improvements or additions to documentation label Sep 6, 2023
@SkafteNicki SkafteNicki added this to the v1.2.0 milestone Sep 6, 2023
@codecov
Copy link

codecov bot commented Sep 6, 2023

Codecov Report

Merging #2061 (4a12e5d) into master (6eb874c) will increase coverage by 2%.
The diff coverage is 100%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #2061    +/-   ##
=======================================
+ Coverage      85%     87%    +2%     
=======================================
  Files         289     289            
  Lines       16125   16129     +4     
=======================================
+ Hits        13648   14018   +370     
+ Misses       2477    2111   -366     

docs/source/pages/implement.rst Show resolved Hide resolved
docs/source/pages/implement.rst Outdated Show resolved Hide resolved
docs/source/pages/implement.rst Outdated Show resolved Hide resolved
docs/source/pages/implement.rst Outdated Show resolved Hide resolved
@mergify mergify bot added the ready label Sep 11, 2023
@Borda Borda merged commit b7b118a into master Sep 15, 2023
64 checks passed
@Borda Borda deleted the docs_custom_impl branch September 15, 2023 18:01
matsumotosan pushed a commit to matsumotosan/metrics that referenced this pull request Sep 17, 2023
Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
matsumotosan pushed a commit to matsumotosan/metrics that referenced this pull request Sep 19, 2023
Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
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.

State Changes from List to Tensor After Calling Compute()
3 participants