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

Update examples in running #2081

Merged
merged 1 commit into from
Sep 14, 2023
Merged

Conversation

OmerShubi
Copy link
Contributor

@OmerShubi OmerShubi commented Sep 14, 2023

Remove the first two lines after the Example:, to fix rendering of the code in the running wrapper documentation.
Similar to Metric tracker docs, add the example name in the title.

What does this PR do?

Fixes #2080

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

Similar to [Metric tracker] docs[https://torchmetrics.readthedocs.io/en/stable/wrappers/metric_tracker.html] add the example name in the title
@Borda Borda changed the title Update running.py Update examples in running Sep 14, 2023
@codecov
Copy link

codecov bot commented Sep 14, 2023

Codecov Report

Merging #2081 (f755008) into master (c24c36a) will decrease coverage by 48%.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff            @@
##           master   #2081     +/-   ##
========================================
- Coverage      87%     39%    -48%     
========================================
  Files         287     287             
  Lines       16072   16072             
========================================
- Hits        13964    6200   -7764     
- Misses       2108    9872   +7764     

@mergify mergify bot added the ready label Sep 14, 2023
@Borda Borda merged commit 9b21108 into Lightning-AI:master Sep 14, 2023
matsumotosan pushed a commit to matsumotosan/metrics that referenced this pull request Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Running Wrapper documentation code example does not render
4 participants