[AIR][Doc] New Example: LightningTrainer with experiment tracking tools #34812
Conversation
This file contains 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
Signed-off-by: woshiyyya <[email protected]>
woshiyyya
changed the title
woshiyyya
requested review from
richardliaw,
krfricke,
xwjiang2010,
amogkam,
matthewdeng,
Yard1,
maxpumperla and
a team
as code owners
Signed-off-by: woshiyyya <[email protected]>
…_tracking_example
Signed-off-by: woshiyyya <[email protected]>
woshiyyya
changed the title
Signed-off-by: woshiyyya <[email protected]>
Signed-off-by: woshiyyya <[email protected]>
…_tracking_example
justinvyu
reviewed
May 16, 2023
There was a problem hiding this comment.
Nice! Can we also add this example to the table of contents under the other lightning examples.
Nit: Also, I think all lightning examples are tested on GPU right now, but this example only needs CPU? Maybe we can split the folder into examples/lightning/cpu and examples/lightning/gpu.
doc/source/train/examples/lightning/lightning_exp_tracking.ipynb
Outdated
Show resolved
Hide resolved
doc/source/train/examples/lightning/lightning_exp_tracking.ipynb
Outdated
Show resolved
Hide resolved
doc/source/train/examples/lightning/lightning_exp_tracking.ipynb
Outdated
Show resolved
Hide resolved
doc/source/train/examples/lightning/lightning_exp_tracking.ipynb
Outdated
Show resolved
Hide resolved
doc/source/train/examples/lightning/lightning_exp_tracking.ipynb
Outdated
Show resolved
Hide resolved
Signed-off-by: woshiyyya <[email protected]>
…_tracking_example
Signed-off-by: woshiyyya <[email protected]>
@justinvyu ✅ Created a separate build object that test this example with CPU only. |
…_tracking_example
Signed-off-by: woshiyyya <[email protected]>
Signed-off-by: woshiyyya <[email protected]>
woshiyyya
added
air
tests-ok
matthewdeng
approved these changes
May 17, 2023
| "\n", | ||
| "\n", | ||
| ":::{note}\n", | ||
| "This guide shows how to use the native [Logger](https://lightning.ai/docs/pytorch/stable/extensions/logging.html) integrations in PyTorch Lightning. Ray AIR also provides {ref}`experiment tracking integrations <tune-exp-tracking-ref>` for all the tools mentioned in this example. We recommend sticking with the PyTorch Lightning loggers.\n", |
There was a problem hiding this comment.
Is there any scenario the user would want to use the AIR integrations instead?
There was a problem hiding this comment.
Yes. One case I can think of is when a user wants more flexible logging, our integration allows users to directly interact with (e.g. wandb) client objects. However, the Lightning's logger has another layer of abstraction, so some APIs may not be supported by Lightning's logger.
doc/source/train/examples/lightning/lightning_exp_tracking.ipynb
Outdated
Show resolved
Hide resolved
doc/source/train/examples/lightning/lightning_exp_tracking.ipynb
Outdated
Show resolved
Hide resolved
Co-authored-by: matthewdeng <[email protected]> Signed-off-by: Yunxuan Xiao <[email protected]>
richardliaw
approved these changes
May 18, 2023
woshiyyya
added a commit
to woshiyyya/ray
that referenced
this pull request
May 19, 2023
…ls (ray-project#34812) Signed-off-by: woshiyyya <[email protected]>
8 tasks
scv119
pushed a commit
to scv119/ray
that referenced
this pull request
Jun 16, 2023
…ls (ray-project#34812) Signed-off-by: woshiyyya <[email protected]>
arvind-chandra
pushed a commit
to lmco/ray
that referenced
this pull request
Aug 31, 2023
…ls (ray-project#34812) Signed-off-by: woshiyyya <[email protected]> Signed-off-by: e428265 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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?
Some users have trouble using wandb/cometML for experiment tracking while onboarding LightningTrainer. They are struggling between PTL native logger and our Ray integration.
This example aims to show the best practices of how to use PTL native logger in LightningTrainer.
Rendered doc: https://anyscale-ray--34812.com.readthedocs.build/en/34812/train/examples/lightning/lightning_exp_tracking.html
Related issue number
Close #34869
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.