-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Update docs with new Lightning Lite usage 1/n #15600
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This effectively forces us to release lite on the next minor release. It would be weird to have it in the docs if we are going to have large breaking changes by changing the names. Is this agreed on?
cc: @lantiga |
This PR doesn't change any names or breaks APIs. I'm updating the docs based on what we have in master. Old code will still work. I am quite confused about what the issue here is. Where would you expect this documentation to show up if not here? |
I'm just saying that since this PR changes the docs to use the new package and imports, then whoever is reading the docs will see this. Right now it's only on the "latest" docs, but not anymore after we make a 1.x release which means that it would be messy to change names after that. This is also related to the motivation in #15586 (comment) |
Oh I see. I think you mean the changes I made from
|
Reverted the link changes. Now still points to :class:~pytorch_lightning.lite.LightningLite |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM !
What does this PR do?
We introduced a new way to interact with Lightning Lite in #14992. The
run
method approach is no longer the recommended way moving forward.This first PR focuses on
Future PRs will need to
Before submitting
PR review
Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:
Did you have fun?
I made sure I had fun coding 🙃
cc @Borda @carmocca @justusschock @awaelchli