[Doc] Update Serve replica scheduling docs for label_selector and fal… by ryanaoleary · Pull Request #60922 · ray-project/ray

ryanaoleary · 2026-02-10T11:14:39Z

Description

This PR adds documentation for the changes added in #57694, specifically the label_selector, fallback_strategy, and placement_group_bundle_label_selector added to the Serve API.

Related issues

#51564

Additional information

…lback_strategy API Signed-off-by: ryanaoleary <ryanaoleary@google.com>

gemini-code-assist

Code Review

This pull request updates the replica scheduling documentation to incorporate new features: label_selector, fallback_strategy, and placement_group_bundle_label_selector. The changes are well-structured and clearly explain the new functionalities with corresponding code examples. I've identified a minor typo and suggested including a missing code example to enhance the documentation's clarity.

doc/source/serve/advanced-guides/replica-scheduling.md

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Ryan O'Leary <113500783+ryanaoleary@users.noreply.github.com>

abrarsheikh · 2026-02-10T19:59:47Z

doc/source/serve/doc_code/replica_scheduling.py


-# __custom_resources_main_start__
+# __label_selector_main_start__
 if __name__ == "__main__":


Similarly, let's make other examples runnable at doc test time. That will ensure examples dont drift with changing APIs

Done in 5942593 and dd88395, I added resources to the RayCluster and similar serve.run calls

doc/source/serve/advanced-guides/replica-scheduling.md

abrarsheikh · 2026-02-10T20:04:12Z

doc/source/serve/advanced-guides/replica-scheduling.md

wonder what the behavior is with label selector?

It filters by label selector first and then does the bin-packing, added this description in:
e65d60b

Signed-off-by: ryanaoleary <ryanaoleary@google.com>

abrarsheikh · 2026-02-13T21:48:20Z

@ryanaoleary please fix the doc test


[2026-02-13T18:17:32Z] ==================== Test output for //doc:source/serve/doc_code/replica_scheduling:
--
[2026-02-13T18:17:32Z] Traceback (most recent call last):
[2026-02-13T18:17:32Z]   File "/root/.cache/bazel/_bazel_root/1df605deb6d24fc8068f6e25793ec703/execroot/io_ray/bazel-out/k8-opt/bin/doc/source/serve/doc_code/replica_scheduling.runfiles/io_ray/doc/source/serve/doc_code/replica_scheduling.py", line 40, in <module>
[2026-02-13T18:17:32Z]     def PlacementGroupBundleLabelSelector(request):
[2026-02-13T18:17:32Z]   File "/rayci/python/ray/serve/api.py", line 487, in decorator
[2026-02-13T18:17:32Z]     replica_config = ReplicaConfig.create(
[2026-02-13T18:17:32Z]   File "/rayci/python/ray/serve/_private/config.py", line 630, in create
[2026-02-13T18:17:32Z]     config = cls(
[2026-02-13T18:17:32Z]   File "/rayci/python/ray/serve/_private/config.py", line 518, in __init__
[2026-02-13T18:17:32Z]     self._validate()
[2026-02-13T18:17:32Z]   File "/rayci/python/ray/serve/_private/config.py", line 543, in _validate
[2026-02-13T18:17:32Z]     self._validate_placement_group_options()
[2026-02-13T18:17:32Z]   File "/rayci/python/ray/serve/_private/config.py", line 762, in _validate_placement_group_options
[2026-02-13T18:17:32Z]     raise ValueError(
[2026-02-13T18:17:32Z] ValueError: When using `placement_group_bundles`, the replica actor will be placed in the first bundle, so the resource requirements for the actor must be a subset of the first bundle. `num_cpus` for the actor is 1, but the bundle only has 0 `CPU` specified.
[2026-02-13T18:17:32Z] ================================================================================

Signed-off-by: ryanaoleary <ryanaoleary@google.com>

ryanaoleary · 2026-02-14T00:33:19Z

Should be fixed with b7d26b9, ran it successfully with: python doc/source/serve/doc_code/replica_scheduling.py

Signed-off-by: ryanaoleary <ryanaoleary@google.com>

ray-project#60922) ## Description This PR adds documentation for the changes added in ray-project#57694, specifically the `label_selector`, `fallback_strategy`, and `placement_group_bundle_label_selector` added to the Serve API. ## Related issues ray-project#51564 ## Additional information --------- Signed-off-by: ryanaoleary <ryanaoleary@google.com> Signed-off-by: Ryan O'Leary <113500783+ryanaoleary@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Adel Nour <ans9868@nyu.edu>

ray-project#60922) ## Description This PR adds documentation for the changes added in ray-project#57694, specifically the `label_selector`, `fallback_strategy`, and `placement_group_bundle_label_selector` added to the Serve API. ## Related issues ray-project#51564 ## Additional information --------- Signed-off-by: ryanaoleary <ryanaoleary@google.com> Signed-off-by: Ryan O'Leary <113500783+ryanaoleary@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

ray-project#60922) ## Description This PR adds documentation for the changes added in ray-project#57694, specifically the `label_selector`, `fallback_strategy`, and `placement_group_bundle_label_selector` added to the Serve API. ## Related issues ray-project#51564 ## Additional information --------- Signed-off-by: ryanaoleary <ryanaoleary@google.com> Signed-off-by: Ryan O'Leary <113500783+ryanaoleary@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: peterxcli <peterxcli@gmail.com>

ray-project#60922) ## Description This PR adds documentation for the changes added in ray-project#57694, specifically the `label_selector`, `fallback_strategy`, and `placement_group_bundle_label_selector` added to the Serve API. ## Related issues ray-project#51564 ## Additional information --------- Signed-off-by: ryanaoleary <ryanaoleary@google.com> Signed-off-by: Ryan O'Leary <113500783+ryanaoleary@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

[Doc] Update Serve replica scheduling docs for label_selector and fal…

f57cdd8

…lback_strategy API Signed-off-by: ryanaoleary <ryanaoleary@google.com>

ryanaoleary requested a review from a team as a code owner February 10, 2026 11:14

gemini-code-assist bot reviewed Feb 10, 2026

View reviewed changes

doc/source/serve/advanced-guides/replica-scheduling.md Outdated Show resolved Hide resolved

doc/source/serve/advanced-guides/replica-scheduling.md Show resolved Hide resolved

ryanaoleary and others added 3 commits February 10, 2026 04:27

Update doc/source/serve/advanced-guides/replica-scheduling.md

241aa8f

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Ryan O'Leary <113500783+ryanaoleary@users.noreply.github.com>

Apply suggestion from @gemini-code-assist[bot]

81fbe83

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Ryan O'Leary <113500783+ryanaoleary@users.noreply.github.com>

Merge branch 'master' into serve-doc-update-labels

91bf088

ray-gardener bot added the community-contribution Contributed by the community label Feb 10, 2026

abrarsheikh reviewed Feb 10, 2026

View reviewed changes

abrarsheikh added the serve Ray Serve Related Issue label Feb 12, 2026

ryanaoleary added 2 commits February 13, 2026 13:40

Make all examples runnable

5942593

Signed-off-by: ryanaoleary <ryanaoleary@google.com>

Fix comments

e65d60b

Signed-off-by: ryanaoleary <ryanaoleary@google.com>

ryanaoleary requested a review from abrarsheikh February 13, 2026 13:45

Consolidate __main__ blocks

dd88395

Signed-off-by: ryanaoleary <ryanaoleary@google.com>

abrarsheikh added the go add ONLY when ready to merge, run all tests label Feb 13, 2026

Fix doc code test

b7d26b9

Signed-off-by: ryanaoleary <ryanaoleary@google.com>

ryanaoleary and others added 2 commits February 13, 2026 16:33

Merge branch 'master' into serve-doc-update-labels

fef2529

Fix literalinclude

c0394f4

Signed-off-by: ryanaoleary <ryanaoleary@google.com>

abrarsheikh approved these changes Feb 17, 2026

View reviewed changes

abrarsheikh merged commit 10176c4 into ray-project:master Feb 17, 2026
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Doc] Update Serve replica scheduling docs for label_selector and fal…#60922

[Doc] Update Serve replica scheduling docs for label_selector and fal…#60922
abrarsheikh merged 10 commits intoray-project:masterfrom
ryanaoleary:serve-doc-update-labels

ryanaoleary commented Feb 10, 2026

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

Uh oh!

Uh oh!

abrarsheikh Feb 10, 2026

Uh oh!

ryanaoleary Feb 13, 2026 •

edited

Loading

Uh oh!

Uh oh!

abrarsheikh Feb 10, 2026

Uh oh!

ryanaoleary Feb 13, 2026 •

edited

Loading

Uh oh!

abrarsheikh commented Feb 13, 2026

Uh oh!

ryanaoleary commented Feb 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

ryanaoleary commented Feb 10, 2026

Description

Related issues

Additional information

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

abrarsheikh Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

ryanaoleary Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

abrarsheikh Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

ryanaoleary Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abrarsheikh commented Feb 13, 2026

Uh oh!

ryanaoleary commented Feb 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ryanaoleary Feb 13, 2026 •

edited

Loading

ryanaoleary Feb 13, 2026 •

edited

Loading