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

[Docs] Update TPU Documentation #50056

Merged
merged 8 commits into from
Feb 13, 2025
Merged

Conversation

ryanaoleary
Copy link
Contributor

Why are these changes needed?

This PR contains some small edits to the TPU Ray documentation to clarify the sections, specifically making it more clear that the Ray TPU initialization webhook is included in the GKE Ray addon and manual installation is optional.

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: Ryan O'Leary <ryanaoleary@google.com>
ryanaoleary and others added 4 commits January 24, 2025 20:56
Signed-off-by: Ryan O'Leary <ryanaoleary@google.com>
Signed-off-by: Ryan O'Leary <ryanaoleary@google.com>
Signed-off-by: Ryan O'Leary <ryanaoleary@google.com>
Copy link
Contributor

@andrewsykim andrewsykim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some minor comments, LGTM otherwise

@jcotant1 jcotant1 added the docs An issue or change related to documentation label Jan 27, 2025
ryanaoleary and others added 2 commits January 28, 2025 17:17
Signed-off-by: Ryan O'Leary <ryanaoleary@google.com>
@kevin85421 kevin85421 self-assigned this Jan 29, 2025
@kevin85421
Copy link
Member

I have already pinged Ray doc team to review.

@richardliaw richardliaw added the go add ONLY when ready to merge, run all tests label Jan 30, 2025
Copy link
Contributor

@dayshah dayshah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm from docs perspective

@ryanaoleary
Copy link
Contributor Author

is someone with write access able to merge this for me? @dayshah @kevin85421

@pcmoritz pcmoritz merged commit 514cf64 into ray-project:master Feb 13, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs An issue or change related to documentation go add ONLY when ready to merge, run all tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants