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

Fix LightningCLI docs after overhaul of the documentation #14976

Merged
merged 12 commits into from
Nov 9, 2022
Merged

Fix LightningCLI docs after overhaul of the documentation #14976

merged 12 commits into from
Nov 9, 2022

Conversation

mauvilsa
Copy link
Contributor

@mauvilsa mauvilsa commented Oct 3, 2022 •
edited by carmocca
Loading

What does this PR do?

Fixes #13249

I found many more issues not mentioned in #13249. And still some things might need improvement, hopefully we can fix them with the reviews.

Does your PR introduce any breaking changes? If yes, please list them.

None

Before submitting

  • Was this discussed/approved 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)
  • [n/a] 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?
  • [n/a] 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:

  • 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

Did you have fun?

Make sure you had fun coding 🙃

cc @carmocca

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Oct 3, 2022
@mauvilsa
- Fix diverse issues introduced when the documentation was restructured.
82a50db 
- Change the docs to be focused on configure hyperparameters instead of reduction of bolierplate.
@mauvilsa mauvilsa changed the title Fix LightningCLI docs after restructuring Fix LightningCLI docs after overhaul of the documentation Oct 3, 2022
@mauvilsa mauvilsa marked this pull request as ready for review October 3, 2022 17:16
@awaelchli awaelchli added docs Documentation related lightningcli pl.cli.LightningCLI labels Oct 3, 2022
@awaelchli awaelchli added this to the pl:1.8 milestone Oct 3, 2022
@mauvilsa mauvilsa mentioned this pull request Oct 4, 2022
Merged
12 tasks
@carmocca carmocca modified the milestones: v1.8, v1.9 Oct 13, 2022
@mauvilsa mauvilsa mentioned this pull request Oct 23, 2022
Merged
12 tasks
@awaelchli awaelchli requested a review from carmocca October 23, 2022 18:55
awaelchli
awaelchli approved these changes Oct 23, 2022
View reviewed changes
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great improvements!

One suggestion for future work: In large PRs like this one, it would be great if you could give the reviewer some guidance on what has been moved where, as it is not so easy to discover just from the diff.

docs/source-pytorch/cli/lightning_cli.rst Outdated Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli.rst Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli.rst Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli.rst Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli_advanced.rst Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli_advanced_3.rst Show resolved Hide resolved
@mergify mergify bot added the ready PRs ready to be merged label Oct 24, 2022
@Borda
Copy link
Member

Borda commented Oct 25, 2022

@RobertLaurella could you pls check this out 🦦

@Borda Borda enabled auto-merge (squash) October 25, 2022 22:46
@mauvilsa mauvilsa mentioned this pull request Oct 26, 2022
Closed
rohitgr7
rohitgr7 approved these changes Nov 1, 2022
View reviewed changes
Copy link
Contributor

@rohitgr7 rohitgr7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great work!
is there a book on lightning cli? 😄

docs/source-pytorch/cli/lightning_cli.rst Outdated Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli_advanced.rst Outdated Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli_advanced.rst Outdated Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli_advanced.rst Outdated Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli_advanced.rst Outdated Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli_advanced_3.rst Outdated Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli_advanced_3.rst Outdated Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli_advanced_3.rst Outdated Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli_advanced_3.rst Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli_expert.rst Outdated Show resolved Hide resolved
auto-merge was automatically disabled November 1, 2022 19:55

Head branch was pushed to by a user without write access

@mauvilsa
Copy link
Contributor Author

mauvilsa commented Nov 2, 2022

Question. Why is this v1.9? It only fixes the documentation of what is currently supported. Nothing related to new features.

@awaelchli
Copy link
Contributor

@mauvilsa We don't usually cherry pick docs updates into our bugfix releases (1.8.x), which is why this is labelled 1.9. Once this is merged, the changes will appear on the website under "latest". I think we should move forward and merge this as soon as possible :)

Note: Might also be worth checking #15473 for possible collisions as it will probably land very soon too.

@carmocca carmocca self-assigned this Nov 9, 2022
@carmocca carmocca added the community This PR is from the community label Nov 9, 2022
@lexierule lexierule merged commit acccc4d into Lightning-AI:master Nov 9, 2022
@mauvilsa mauvilsa deleted the cli-fix-docs-after-restructure branch November 9, 2022 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carmocca carmocca carmocca approved these changes

@awaelchli awaelchli awaelchli approved these changes

@rohitgr7 rohitgr7 rohitgr7 approved these changes

@williamFalcon williamFalcon Awaiting requested review from williamFalcon williamFalcon is a code owner

@edenlightning edenlightning Awaiting requested review from edenlightning

@tchaton tchaton Awaiting requested review from tchaton tchaton is a code owner

@Borda Borda Awaiting requested review from Borda Borda is a code owner

Assignees

@carmocca carmocca

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
Milestone
v1.9
Development

Successfully merging this pull request may close these issues.

Suggestions to improve LightningCLI documentation
6 participants
@mauvilsa @Borda @awaelchli @carmocca @rohitgr7 @lexierule