Skip to content

[doc][train] Update scaling config documentation in Ray Train for TPUs#62584

Merged
matthewdeng merged 5 commits into
ray-project:masterfrom
liulehui:train-tpu-doc
Apr 22, 2026
Merged

[doc][train] Update scaling config documentation in Ray Train for TPUs#62584
matthewdeng merged 5 commits into
ray-project:masterfrom
liulehui:train-tpu-doc

Conversation

@liulehui

@liulehui liulehui commented Apr 14, 2026

Copy link
Copy Markdown
Contributor

Description

Improve the TPU section of the Ray Train scaling/accelerators user guide:

  • Clarify that topology and accelerator_type are required for all use_tpu=True usage.
  • Document multi-slice TPU support: num_workers can be a multiple of the VM count to launch multiple slices
  • List all valid TPU accelerator types: TPU-V2, TPU-V3, TPU-V4, TPU-V5P, TPU-V5LITEPOD, TPU-V6E, TPU-V7X

Additional information

created a redirect:
image

make develop && make local
e70ba6d8873321e9ab649873d043f696

cdc7bc8a93f060acf275a03d453c454c 35918821801237cbbef0bee411793017 2aafc2ba7313a4b1517a65ef9426aa64 2f4f793892da067df8736188f2305853 4a4445a76f39151adc293d4cdf9f10a7
@liulehui liulehui requested review from a team as code owners April 14, 2026 00:40

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request renames the "Using GPUs" guide to "Configuring scale and accelerators" and adds documentation for TPU support in Ray Train. It updates references in build files, tutorials, and user guides. Feedback includes suggestions to use more idiomatic phrasing and clarify resource allocation descriptions in the documentation.

Comment thread doc/source/train/user-guides/using-accelerators.rst Outdated
Comment thread doc/source/train/user-guides/using-accelerators.rst Outdated
@ray-gardener ray-gardener Bot added docs An issue or change related to documentation train Ray Train Related Issue labels Apr 14, 2026
@liulehui liulehui added the go add ONLY when ready to merge, run all tests label Apr 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Renaming this is a problem if there are any existing references to the old URL (e.g. on external websites). Can you work with @dstrodtman to make sure the redirect is set up properly on readthedocs?

Comment thread doc/source/train/user-guides/using-accelerators.rst
Comment thread doc/source/train/user-guides/using-accelerators.rst Outdated
Comment thread doc/source/train/user-guides/using-accelerators.rst Outdated
Comment thread doc/source/train/user-guides/using-accelerators.rst Outdated
Comment thread doc/source/train/user-guides/using-accelerators.rst Outdated
Comment thread doc/source/train/user-guides/using-accelerators.rst
Comment thread doc/source/train/user-guides/using-accelerators.rst Outdated
Signed-off-by: Lehui Liu <lehui@anyscale.com>
Signed-off-by: Lehui Liu <lehui@anyscale.com>
Signed-off-by: Lehui Liu <lehui@anyscale.com>
Signed-off-by: Lehui Liu <lehui@anyscale.com>
Signed-off-by: Lehui Liu <lehui@anyscale.com>
@matthewdeng matthewdeng enabled auto-merge (squash) April 22, 2026 17:37
@matthewdeng matthewdeng merged commit b3ce651 into ray-project:master Apr 22, 2026
7 checks passed
Lucas61000 pushed a commit to Lucas61000/ray that referenced this pull request May 15, 2026
ray-project#62584)

## Description
Improve the TPU section of the Ray Train scaling/accelerators user
guide:
- Clarify that `topology` and `accelerator_type` are required for all
`use_tpu=True` usage.
- Document multi-slice TPU support: `num_workers` can be a multiple of
the VM count to launch multiple slices
- List all valid TPU accelerator types: TPU-V2, TPU-V3, TPU-V4, TPU-V5P,
TPU-V5LITEPOD, TPU-V6E, TPU-V7X


## Additional information

created a redirect: 
<img width="1524" height="158" alt="image"
src="https://github.com/user-attachments/assets/7bb7b631-4670-4e31-a590-6b60e6183cb5"
/>

`make develop` && `make local`
<img width="1882" height="1386" alt="e70ba6d8873321e9ab649873d043f696"
src="https://github.com/user-attachments/assets/f2a68d70-4ed2-450f-9905-51f6bae0d69d"
/>

<img width="1936" height="1528" alt="cdc7bc8a93f060acf275a03d453c454c"
src="https://github.com/user-attachments/assets/3342437d-bc57-498f-8896-ed7333f34138"
/>
<img width="1894" height="906" alt="35918821801237cbbef0bee411793017"
src="https://github.com/user-attachments/assets/adb35fb7-df97-4f25-b575-2984602c760e"
/>
<img width="1816" height="984" alt="2aafc2ba7313a4b1517a65ef9426aa64"
src="https://github.com/user-attachments/assets/b6aa49f5-42e0-4ac8-94e4-e3139076709a"
/>

<img width="1808" height="1556" alt="2f4f793892da067df8736188f2305853"
src="https://github.com/user-attachments/assets/65b1a0f3-5dd5-4164-8646-33c05a3397e9"
/>
<img width="1830" height="840" alt="4a4445a76f39151adc293d4cdf9f10a7"
src="https://github.com/user-attachments/assets/ac1e0ab7-7197-43d0-8cc1-8b52ad1ab20a"
/>

---------

Signed-off-by: Lehui Liu <lehui@anyscale.com>
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 train Ray Train Related Issue

2 participants