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

The default value of compute_with_cache should be True . #2496

Closed
S-aiueo32 opened this issue Apr 12, 2024 · 2 comments · Fixed by #2499
Closed

The default value of compute_with_cache should be True . #2496

S-aiueo32 opened this issue Apr 12, 2024 · 2 comments · Fixed by #2499
Labels
documentation Improvements or additions to documentation

Comments

@S-aiueo32
Copy link
Contributor

📚 Documentation

I found an inconsistency around compute_with_cache in Metic.
The docstring says the default value is False but the actual one is True.

torchmetrics/src/torchmetrics/metric.py

Line 78 in ca7c8eb

- compute_with_cache: If results from ``compute`` should be cached. Default is ``False``

torchmetrics/src/torchmetrics/metric.py

Line 140 in ca7c8eb

self.compute_with_cache = kwargs.pop("compute_with_cache", True)

@S-aiueo32 S-aiueo32 added the documentation Improvements or additions to documentation label Apr 12, 2024
@github-actions GitHub Actions
Copy link

Hi! thanks for your contribution!, great first issue!

@S-aiueo32
Copy link
Contributor Author

I'm ready to send PR from here.

@S-aiueo32 S-aiueo32 mentioned this issue Apr 13, 2024
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update compute_with_cache default value to True in Metric class S-aiueo32/torchmetrics
1 participant
@S-aiueo32