Skip to content

[Train] Update elastic training accelerator examples in docs#64284

Open
avigyabb wants to merge 2 commits into
ray-project:masterfrom
avigyabb:docs-elastic-training-tpu
Open

[Train] Update elastic training accelerator examples in docs#64284
avigyabb wants to merge 2 commits into
ray-project:masterfrom
avigyabb:docs-elastic-training-tpu

Conversation

@avigyabb

@avigyabb avigyabb commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Description

Updates the Ray Train elastic training docs to show accelerator-specific examples for both GPUs and TPUs.

This removes the outdated TPU limitation and adds a JaxTrainer example for elastic training across TPU slices. The TPU example documents that elastic worker ranges must align with complete TPU slices, matching the existing accelerator guide and ScalingConfig validation behavior.

Screenshots:
Screenshot 2026-07-06 at 12 42 22 PM
Screenshot 2026-07-06 at 12 42 32 PM

@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 updates the elastic training documentation to include support for TPUs. It replaces the single GPU example with a tabbed set showing both GPU and TPU configurations, and removes the limitation stating that TPU elastic training is unsupported. The feedback points out a minor typo with double periods in the TPU example description.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread doc/source/train/user-guides/elastic-training.rst Outdated
Signed-off-by: Avigya Basnet <avigyabb@stanford.edu>
@avigyabb avigyabb force-pushed the docs-elastic-training-tpu branch from 7122f0f to 80308b7 Compare June 23, 2026 18:27
@avigyabb avigyabb changed the title Update elastic training accelerator examples [Train] Update elastic training accelerator examples in docs Jun 23, 2026
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: avigyabb <98926738+avigyabb@users.noreply.github.com>
@liulehui liulehui marked this pull request as ready for review June 24, 2026 16:32
@liulehui liulehui requested a review from a team as a code owner June 24, 2026 16:32
@liulehui liulehui added the go add ONLY when ready to merge, run all tests label Jun 24, 2026
@ray-gardener ray-gardener Bot added docs An issue or change related to documentation train Ray Train Related Issue labels Jun 24, 2026

@liulehui liulehui 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.

Thank you!

Could you follow https://docs.ray.io/en/latest/ray-contribute/docs.html this doc to start the doc server locally to view the new changes, plz also attach screenshots of the corresponding doc change part in the PR description.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants