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

Docs on memory management #2006

Merged
merged 12 commits into from
Aug 22, 2023
Merged

Docs on memory management #2006

merged 12 commits into from
Aug 22, 2023

Conversation

SkafteNicki
Copy link
Member

@SkafteNicki SkafteNicki commented Aug 21, 2023

What does this PR do?

Fixes #1949
Add a section about good memory management advice.
Also adds a new public attribute called metric_state such that users should be able to always investigate what is currently stored by the metric.

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

@SkafteNicki SkafteNicki added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 21, 2023
@codecov
Copy link

codecov bot commented Aug 21, 2023

Codecov Report

Merging #2006 (b68e5b4) into master (a3eebd7) will increase coverage by 0%.
Report is 1 commits behind head on master.
The diff coverage is 100%.

Additional details and impacted files
@@          Coverage Diff           @@
##           master   #2006   +/-   ##
======================================
  Coverage      87%     87%           
======================================
  Files         270     270           
  Lines       15581   15584    +3     
======================================
+ Hits        13483   13486    +3     
  Misses       2098    2098           

@mergify mergify bot added the ready label Aug 21, 2023
@Borda Borda enabled auto-merge (squash) August 21, 2023 10:03
@SkafteNicki SkafteNicki added this to the v1.1.0 milestone Aug 21, 2023
@Yann-CV
Copy link

Yann-CV commented Aug 22, 2023

Thanks for this @SkafteNicki !

@Borda Borda disabled auto-merge August 22, 2023 08:52
@Borda Borda merged commit bc8e016 into master Aug 22, 2023
@Borda Borda deleted the memory_management branch August 22, 2023 08:53
matsumotosan pushed a commit to matsumotosan/metrics that referenced this pull request Aug 25, 2023
Co-authored-by: Daniel Stancl <[email protected]>
Co-authored-by: Jirka <[email protected]>
Co-authored-by: Jirka Borovec <[email protected]>
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 enhancement New feature or request ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Memory leak when creating multiple instances of the same metric
5 participants