[Train][Doc] Improve AIR Lightning APIs and docstrings - #33895
Merged
gjoliver merged 10 commits intoMar 31, 2023
Conversation
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
woshiyyya
marked this pull request as ready for review
March 29, 2023 23:35
woshiyyya
requested review from
a team,
Yard1,
amogkam,
krfricke,
matthewdeng,
maxpumperla,
richardliaw and
xwjiang2010
as code owners
March 29, 2023 23:35
woshiyyya
changed the title
krfricke
approved these changes
Mar 30, 2023
krfricke
left a comment
krfricke
left a comment
Contributor
There was a problem hiding this comment.
Looks good to me so far!
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
gjoliver
reviewed
Mar 30, 2023
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
matthewdeng
approved these changes
Mar 31, 2023
richardliaw
approved these changes
Mar 31, 2023
zhe-thoughts
approved these changes
Mar 31, 2023
zhe-thoughts
left a comment
zhe-thoughts
left a comment
Contributor
There was a problem hiding this comment.
Approved for merging to master. Low risk docs / examples change, in a new component
…htning-api-and-doc
elliottower
pushed a commit
to elliottower/ray
that referenced
this pull request
Apr 22, 2023
…3895) Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com> Signed-off-by: elliottower <elliot@elliottower.com>
ProjectsByJackHe
pushed a commit
to ProjectsByJackHe/ray
that referenced
this pull request
May 4, 2023
…3895) Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com> Signed-off-by: Jack He <jackhe2345@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
During the LightningTrainer bug-bash session, we collected a lot of constructive feedback to improve the user experience. This PR aims to address these feedbacks:
LightningTrainer:
LightningCheckpoint:
.from_directory()and.get_model()usage in the docstring.load_from_checkpoint_kwargsargument type from dict to **kwargs.checkpoint.from_path(): if the provided path is a directory, then instruct them to provide a file path, or to use from_directory() instead.LightningConfigBuilder:
checkpointing(),fit_params(),module(), andtrainer().fit_params().CheckpointConfigeven if they have already set it in theLightningConfigBuilder.checkpointing().Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.