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: fix LightningCLI docs example for Trainer Callbacks #19701

Merged
merged 1 commit into from
Mar 27, 2024

Conversation

Lunamos
Copy link
Contributor

@Lunamos Lunamos commented Mar 26, 2024

What does this PR do?

Fixes #19696

Minor modifications to wrong example in Configure hyperparameters from the CLI (Advanced)

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

📚 Documentation preview 📚: https://pytorch-lightning--19701.org.readthedocs.build/en/19701/

@github-actions github-actions bot added docs Documentation related pl Generic label for PyTorch Lightning package labels Mar 26, 2024
@awaelchli awaelchli added lightningcli pl.cli.LightningCLI community This PR is from the community labels Mar 26, 2024
@awaelchli awaelchli added this to the 2.3 milestone Mar 26, 2024
@awaelchli awaelchli requested a review from carmocca March 27, 2024 22:00
@carmocca carmocca merged commit 94167d6 into Lightning-AI:master Mar 27, 2024
26 checks passed
@mergify mergify bot added the ready PRs ready to be merged label Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community This PR is from the community docs Documentation related lightningcli pl.cli.LightningCLI pl Generic label for PyTorch Lightning package ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

LightningCLI docs example for EarlyStopping missing required args in config file
3 participants