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

[Doc] [Serve] Add docs for custom resources with Serve #28529

Merged
merged 6 commits into from
Sep 21, 2022

Conversation

architkulkarni
Copy link
Contributor

Why are these changes needed?

  • Adds an example to the docs about using custom resources with Ray Serve
  • Documents which options are allowed for ray_actor_options

Related issue number

Closes #28477

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 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 :(

Copy link
Contributor

@shrekris-anyscale shrekris-anyscale left a comment

Choose a reason for hiding this comment

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

Nice work! Can we also explicitly list

  1. The ray_actor_options options somewhere in the docs (instead of only in the docstring)?
  2. The accelerator types that are allowed? I believe only the accelerators from accelerators.py are allowed. @simon-mo do you know if other accelerators can be used?

python/ray/serve/api.py Outdated Show resolved Hide resolved
Co-authored-by: shrekris-anyscale <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
@architkulkarni architkulkarni added the @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. label Sep 15, 2022
@architkulkarni
Copy link
Contributor Author

@shrekris-anyscale Thanks, I've just linked to the existing accelerator doc which seems to say that those are the only available types. Ready for review again

@architkulkarni architkulkarni removed the @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. label Sep 16, 2022
Copy link
Contributor

@shrekris-anyscale shrekris-anyscale left a comment

Choose a reason for hiding this comment

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

Nice work!

@architkulkarni architkulkarni added the @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. label Sep 19, 2022
@architkulkarni architkulkarni removed the @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. label Sep 19, 2022
@architkulkarni
Copy link
Contributor Author

@ray-project/ray-docs Could you please give codeowner approval?

@ericl ericl merged commit fa182d3 into ray-project:master Sep 21, 2022
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.

[Serve] [Docs] Document ray_actor_options options
5 participants