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.

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

Merged
merged 22 commits into from
Aug 11, 2023

Conversation

matthewdeng
Copy link
Contributor

@matthewdeng matthewdeng commented Aug 10, 2023

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.

  1. Add Getting Started with PyTorch and Getting Started with PyTorch Lightning pages.
    1. Labeled as PyTorch and PyTorch Lightning in the Table of Contents.
  2. Rename Distributed PyTorch to User Guides.
    1. Updated the page to have a Table of Contents of the different guides.
  3. Move HuggingFace content into a HuggingFace Transformers & Accelerate page.
    1. This is temporary until we have dedicated pages for these.
  4. Move the LightningTrainer Migration Guide content directly into the Getting Started with PyTorch Lightning page.
  5. Remove the content from Distributed PyTorch and Converting an Existing Training Loop in favor of the above pages.

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
Copy link
Contributor

@krfricke krfricke left a 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

This is not ideal as the distinction between "PyTorch" and "PyTorch Lightning" guide is hard to see ("Lightning" is in the next row).

  1. Should we use "Native PyTorch" or (vanilla/raw/pure) or something like that instead?
  2. Let's start with the framework, e.g. "PyTorch starter guide", "PyTorch Lightning starter guide", "Huggingface Transfomer starter guide" or so?

Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
@matthewdeng matthewdeng marked this pull request as ready for review August 10, 2023 19:22
Signed-off-by: Matthew Deng <matt@anyscale.com>
Copy link
Member

@woshiyyya woshiyyya left a 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)

doc/source/train/getting-started-pytorch.rst Show resolved Hide resolved
doc/source/train/getting-started-pytorch.rst Outdated Show resolved Hide resolved
doc/source/train/getting-started-pytorch.rst Outdated Show resolved Hide resolved
doc/source/train/getting-started-pytorch.rst Outdated Show resolved Hide resolved
matthewdeng and others added 6 commits August 10, 2023 16:42
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>
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
@matthewdeng matthewdeng merged commit 1409c96 into ray-project:master Aug 11, 2023
114 of 117 checks passed
NripeshN pushed a commit to NripeshN/ray that referenced this pull request Aug 15, 2023
harborn pushed a commit to harborn/ray that referenced this pull request Aug 17, 2023
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants