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][Doc] Direct Ingress #29149

Merged
merged 4 commits into from
Oct 13, 2022
Merged

[Serve][Doc] Direct Ingress #29149

merged 4 commits into from
Oct 13, 2022

Conversation

sihanwang41
Copy link
Contributor

@sihanwang41 sihanwang41 commented Oct 7, 2022

Signed-off-by: Sihan Wang [email protected]

Why are these changes needed?

  • Add generated file to make the doc code runnable

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

@architkulkarni architkulkarni 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! I made some edits and had a few minor questions.

One structural nit is that if the codegen part is required for both Serve schema and BYO schema, perhaps it shouldn't be a subsection of Serve schema. But this is very minor, it's up to you

doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/doc_code/direct_ingress.py Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/doc_code/test_service_pb2.py Show resolved Hide resolved
@simon-mo
Copy link
Contributor

simon-mo commented Oct 7, 2022

Please lmk once you addressed @architkulkarni's comments

@c21 c21 added the Ray 2.1 label Oct 7, 2022
Signed-off-by: Sihan Wang <[email protected]>
Copy link
Contributor

@simon-mo simon-mo left a comment

Choose a reason for hiding this comment

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

One major issue we didn't explain is why would people use Serve's gRPC or bring their own gRPC schema. We should add the following paragraphs:

  • What's the benefit of using gRPC: performance, standardization, binary protocol
  • gRPC (builtin or BYO) an entrypoint to Serve's model scaling and deployment graph feature. (We should have examples about that here. Can we have the custom gRPC call a deployment graph?)
  • What does is_driver_deployment mean? (We should say it is experimental)

doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/doc_code/direct_ingress.py Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
doc/source/serve/direct-ingress.md Show resolved Hide resolved
doc/source/serve/direct-ingress.md Show resolved Hide resolved
doc/source/serve/user-guide.md Outdated Show resolved Hide resolved
Copy link
Contributor

@dmatrix dmatrix left a comment

Choose a reason for hiding this comment

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

Left minor nit


* use Serve's internal gRPC schema to send traffic
* bring your own gRPC schema into your Serve application

Copy link
Contributor

Choose a reason for hiding this comment

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

Or have a link to the gRPC documentation.

doc/source/serve/direct-ingress.md Outdated Show resolved Hide resolved
@c21
Copy link
Contributor

c21 commented Oct 8, 2022

Hi @sihanwang41 - could you address the comment?

@c21 c21 removed the Ray 2.1 label Oct 8, 2022
Signed-off-by: Sihan Wang <[email protected]>
@simon-mo
Copy link
Contributor

ping on my suggested edits...

Signed-off-by: Sihan Wang <[email protected]>
@sihanwang41
Copy link
Contributor Author

ping on my suggested edits...

Done! Sorry I miss the comments you left in the second round

@simon-mo simon-mo merged commit 817a721 into ray-project:master Oct 13, 2022
sihanwang41 added a commit to sihanwang41/ray that referenced this pull request Oct 14, 2022
WeichenXu123 pushed a commit to WeichenXu123/ray that referenced this pull request Dec 19, 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.

6 participants