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

[train] minor documentation improvements #38391

Merged
merged 11 commits into from
Aug 15, 2023

Conversation

matthewdeng
Copy link
Contributor

@matthewdeng matthewdeng commented Aug 14, 2023

Why are these changes needed?

  1. Add images to More Frameworks.
  2. Remove Transformers section from More Frameworks since there is now a dedicated page.
  3. Cleanup API Reference page.
    1. Reorder Train Loop APIs in general usage.
    2. Remove Restore API references since they're already part of the Trainer APIs
    3. Remove BaseTrainer methods because they're already in BaseTrainer
    4. Add additional APIs like Result and FailureConfig.
      1. Note: This makes the AIR APIs fail to generate, but I think this is okay given that we are moving all code to point to the train counterparts, and will be removing the air API references in 2.7.
  4. Update ToC.
    1. Remove "Ray Train" prefix for some pages.
    2. Reorder pages so Examples come before Internals.
    3. Remove unneeded dropdown icon for APIs.

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>
@matthewdeng matthewdeng mentioned this pull request Aug 14, 2023
8 tasks
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 14, 2023 19:51
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.

Thanks @matthewdeng ! Looks good to me. Left 2 minor comments.

doc/source/train/api/api.rst Show resolved Hide resolved
doc/BUILD Show resolved Hide resolved
Signed-off-by: Matthew Deng <matt@anyscale.com>
@matthewdeng matthewdeng added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Aug 14, 2023
@matthewdeng matthewdeng merged commit 7762af3 into ray-project:master Aug 15, 2023
18 of 21 checks passed
NripeshN pushed a commit to NripeshN/ray that referenced this pull request Aug 15, 2023
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: NripeshN <nn2012@hw.ac.uk>
harborn pushed a commit to harborn/ray that referenced this pull request Aug 17, 2023
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: harborn <gangsheng.wu@intel.com>
harborn pushed a commit to harborn/ray that referenced this pull request Aug 17, 2023
Signed-off-by: Matthew Deng <matt@anyscale.com>
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Victor <vctr.y.m@example.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tests-ok The tagger certifies test failures are unrelated and assumes personal liability.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants