Skip to content

[Data] Update exclude_resources docs to reflect Train autoscaling coordinator changes#61990

Merged
justinvyu merged 1 commit intoray-project:masterfrom
JasonLi1909:update-data-docs
Mar 24, 2026
Merged

[Data] Update exclude_resources docs to reflect Train autoscaling coordinator changes#61990
justinvyu merged 1 commit intoray-project:masterfrom
JasonLi1909:update-data-docs

Conversation

@JasonLi1909
Copy link
Copy Markdown
Contributor

Summary

After #61703, Ray Train no longer adds training resources to exclude_resources. Instead, training resources are registered directly with the AutoscalingCoordinator. The docs still said training resources are "automatically excluded," which is misleading. This updates the wording to reflect the new behavior.

Changes

  • Update exclude_resources note in doc/source/data/execution-configurations.rst and ExecutionOptions docstring in execution_options.py to clarify that training resources are automatically reserved without needing exclude_resources.

Tests

Doc-only change — no new tests needed.

Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
@JasonLi1909 JasonLi1909 requested a review from a team as a code owner March 23, 2026 18:36
Copy link
Copy Markdown
Contributor

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

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 clarifies the documentation for the exclude_resources parameter in both the reStructuredText documentation and the Python docstring, specifically regarding its interaction with Ray Train. The review suggests an improvement for the Python docstring's formatting to ensure correct rendering and readability, recommending proper indentation for continuation lines of list items.

@ray-gardener ray-gardener bot added docs An issue or change related to documentation data Ray Data-related issues labels Mar 23, 2026
@justinvyu justinvyu enabled auto-merge (squash) March 24, 2026 01:36
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Mar 24, 2026
@justinvyu justinvyu merged commit fac1f45 into ray-project:master Mar 24, 2026
9 checks passed
ryanaoleary pushed a commit to ryanaoleary/ray that referenced this pull request Mar 25, 2026
…rdinator changes (ray-project#61990)

After ray-project#61703, Ray Train no longer adds training resources to
`exclude_resources`. Instead, training resources are registered directly
with the `AutoscalingCoordinator`. The docs still said training
resources are "automatically excluded," which is misleading. This
updates the wording to reflect the new behavior.

Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

data Ray Data-related issues 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.

3 participants