-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
[wip][train] update Ray Train documentation (quickstart, user guides) #38287
Conversation
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
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.
Generally big fan of this.
For naming, the current layout renders for me like this:
![Screenshot 2023-08-10 at 17 04 30](https://private-user-images.githubusercontent.com/14904111/259786153-4ce5afd2-0df4-430c-b3d3-bad65bd3ba21.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA1NzEyMjIsIm5iZiI6MTcyMDU3MDkyMiwicGF0aCI6Ii8xNDkwNDExMS8yNTk3ODYxNTMtNGNlNWFmZDItMGRmNC00MzBjLWIzZDMtYmFkNjViZDNiYTIxLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzEwVDAwMjIwMlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTIyMDVkNTgyMWYwODQwNjM5OGNkYjk1MGM1Mzk0YTdjODA3NTVmYjI1ZmEyMTM5ZDgxOTUxMTAwZTQzNGZkMGMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.1JWH-Xe7y6HYhW7eFq5ThnmswLRuaX2C2R04HivfBjU)
This is not ideal as the distinction between "PyTorch" and "PyTorch Lightning" guide is hard to see ("Lightning" is in the next row).
- Should we use "Native PyTorch" or (vanilla/raw/pure) or something like that instead?
- Let's start with the framework, e.g. "PyTorch starter guide", "PyTorch Lightning starter guide", "Huggingface Transfomer starter guide" or so?
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.
Left some comments. I love these Getting Start Pages. This is very succinct and can be the the major entry point for new users. (Getting Start -> User Guides / API Page)
Co-authored-by: Yunxuan Xiao <xiaoyunxuan1998@gmail.com> Signed-off-by: matthewdeng <matthew.j.deng@gmail.com>
Co-authored-by: Yunxuan Xiao <xiaoyunxuan1998@gmail.com> Signed-off-by: matthewdeng <matthew.j.deng@gmail.com>
Co-authored-by: Yunxuan Xiao <xiaoyunxuan1998@gmail.com> Signed-off-by: matthewdeng <matthew.j.deng@gmail.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
…ray-project#38287) Signed-off-by: NripeshN <nn2012@hw.ac.uk>
…ray-project#38287) Signed-off-by: harborn <gangsheng.wu@intel.com>
…ray-project#38287) Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
…ray-project#38287) Signed-off-by: Victor <vctr.y.m@example.com>
Why are these changes needed?
Rendered docs are here: https://anyscale-ray--38287.com.readthedocs.build/en/38287
This makes a few iterative changes to the Ray Train documentation.
Getting Started with PyTorch
andGetting Started with PyTorch Lightning
pages.PyTorch
andPyTorch Lightning
in the Table of Contents.Distributed PyTorch
toUser Guides
.HuggingFace
content into aHuggingFace Transformers & Accelerate
page.LightningTrainer Migration Guide
content directly into theGetting Started with PyTorch Lightning
page.Distributed PyTorch
andConverting an Existing Training Loop
in favor of the above pages.Related issue number
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.