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

[Serve] Document max_replicas_per_node deployment option #42743

Merged
merged 5 commits into from Jan 31, 2024

Conversation

jjyao
Copy link
Contributor

@jjyao jjyao commented Jan 26, 2024

Why are these changes needed?

Add documentation for max_replicas_per_node deployment option

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: Jiajun Yao <jeromeyjj@gmail.com>
Copy link
Contributor

@edoakes edoakes left a comment

Choose a reason for hiding this comment

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

Please add:

  • A description of what the default scheduling policy is and why it might be problematic.
  • Make it clear that the behavior is only within a deployment and multiple deployments can still share resources.
  • A concrete code example of an application where this is set. Maybe let it have 2 deployments and set max_replicas_per_node=1 on one, max_replicas_per_node=2 on the other. Then describe how these would be scheduled.

doc/source/serve/production-guide/fault-tolerance.md Outdated Show resolved Hide resolved
Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
@jjyao jjyao requested review from edoakes and zcin January 30, 2024 18:03
Copy link
Contributor

@edoakes edoakes left a comment

Choose a reason for hiding this comment

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

Looks great!

doc/source/serve/production-guide/fault-tolerance.md Outdated Show resolved Hide resolved
doc/source/serve/production-guide/fault-tolerance.md Outdated Show resolved Hide resolved
Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
@edoakes edoakes merged commit 91d5af6 into ray-project:master Jan 31, 2024
9 checks passed
@jjyao jjyao deleted the jjyao/max branch January 31, 2024 18:03
omatthew98 pushed a commit to omatthew98/ray that referenced this pull request Jan 31, 2024
…#42743)

* Document max_replicas_per_node deployment option

---------

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants