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

Fix minor typo in Trainer's documentation #19969

Merged
merged 1 commit into from
Jun 13, 2024

Conversation

SamuelLarkin
Copy link
Contributor

@SamuelLarkin SamuelLarkin commented Jun 11, 2024

What does this PR do?

Fixes a minor typo in Trainer's documentation.

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Jun 11, 2024
@Borda Borda added the docs Documentation related label Jun 11, 2024
Copy link

codecov bot commented Jun 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53%. Comparing base (f6fd046) to head (e3f9b22).
Report is 89 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (f6fd046) and HEAD (e3f9b22). Click for more details.

HEAD has 516 uploads less than BASE
Flag BASE (f6fd046) HEAD (e3f9b22)
python3.10 42 11
cpu 146 23
lightning 92 15
pytest 99 2
python3.8 31 6
lightning_fabric 27 0
examples 7 0
app 7 0
python3.11 53 6
gpu 4 2
tpu 1 0
pytorch_lightning 20 10
pytorch2.0 27 12
pytest-full 52 23
pytorch2.1 12 6
pytorch2.3 6 2
pytorch2.2 7 3
lightning_app 4 0
Additional details and impacted files
@@            Coverage Diff             @@
##           master   #19969      +/-   ##
==========================================
- Coverage      84%      53%     -31%     
==========================================
  Files         426      418       -8     
  Lines       35284    35131     -153     
==========================================
- Hits        29620    18711   -10909     
- Misses       5664    16420   +10756     

@awaelchli awaelchli changed the title fix: minor typo in trainer's documentation Fix minor typo in Trainer's documentation Jun 13, 2024
@awaelchli awaelchli added this to the 2.4 milestone Jun 13, 2024
@awaelchli awaelchli merged commit bb511b0 into Lightning-AI:master Jun 13, 2024
94 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related pl Generic label for PyTorch Lightning package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants