[serve] Replace ClassNode and FunctionNode with Application in top-level Serve APIs
#34627
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Edward Oakes <[email protected]>
Signed-off-by: Edward Oakes <[email protected]>
Signed-off-by: Edward Oakes <[email protected]>
Signed-off-by: Edward Oakes <[email protected]>
Signed-off-by: Edward Oakes <[email protected]>
Signed-off-by: Edward Oakes <[email protected]>
Signed-off-by: Edward Oakes <[email protected]>
Signed-off-by: Edward Oakes <[email protected]>
Signed-off-by: Edward Oakes <[email protected]>
edoakes
changed the title
ClassNode and FunctionNode with Application in top-level Serve APIs
edoakes
commented
Apr 21, 2023
| # If the ingress deployment is a function and it is bound to other deployments, | ||
| # reject. | ||
| if isinstance(serve_root_dag, DeploymentFunctionNode) and len(deployments) != 1: | ||
| raise ValueError( |
There was a problem hiding this comment.
This is just pushed down into the DAG code instead of in the top-level API
8 tasks
richardliaw
reviewed
Apr 21, 2023
| @@ -23,7 +23,7 @@ def __setitem__(self, *args): | |||
|
|
|||
|
|
|||
| @DeveloperAPI | |||
| class Application: | |||
| class BuiltApplication: | |||
There was a problem hiding this comment.
FYI, I think you need to manually insert these classes into Sphinx now or else they won't get rendered.
There was a problem hiding this comment.
going to clean up API ref & add this in a separate PR
|
ping @sihanwang41 |
sihanwang41
approved these changes
Apr 24, 2023
ProjectsByJackHe
pushed a commit
to ProjectsByJackHe/ray
that referenced
this pull request
May 4, 2023
…top-level Serve APIs (ray-project#34627) A bit of renaming to streamline the concepts in the API: - Instead of bind() returning ClassNode or FunctionNode (which are very in the weeds), it returns an Application object. - This required renaming the output of serve.build, which I've renamed to BuiltApplication (checks out conceptually - serve.build(app) -> built_app. - From now on, we should never make mention of "nodes" or "graphs" in user-facing docs/docstrings except for where we are explicitly talking about the call graph API (with InputNode: ...). I will update the docs accordingly. - We should also type annotate our documentation examples where possible to make the concepts very clear. Signed-off-by: Jack He <[email protected]>
architkulkarni
pushed a commit
to architkulkarni/ray
that referenced
this pull request
May 16, 2023
…top-level Serve APIs (ray-project#34627) A bit of renaming to streamline the concepts in the API: - Instead of bind() returning ClassNode or FunctionNode (which are very in the weeds), it returns an Application object. - This required renaming the output of serve.build, which I've renamed to BuiltApplication (checks out conceptually - serve.build(app) -> built_app. - From now on, we should never make mention of "nodes" or "graphs" in user-facing docs/docstrings except for where we are explicitly talking about the call graph API (with InputNode: ...). I will update the docs accordingly. - We should also type annotate our documentation examples where possible to make the concepts very clear.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
A bit of renaming to streamline the concepts in the API:
bind()returningClassNodeorFunctionNode(which are very in the weeds), it returns anApplicationobject.serve.build, which I've renamed toBuiltApplication(checks out conceptually -serve.build(app) -> built_app.with InputNode: ...). I will update the docs accordingly.Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.