[Core][2/3] Make streaming generator public API #38784 #41436
Merged
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
rkooo567
requested review from
edoakes,
shrekris-anyscale,
sihanwang41,
zcin,
architkulkarni,
a team,
ericl,
scv119,
c21,
amogkam,
scottjlee,
bveeramani,
raulchen,
stephanie-wang,
Zandew and
pcmoritz
as code owners
rkooo567
commented
Nov 28, 2023
| @@ -544,9 +544,9 @@ def _submit_task( | |||
| """Submit the task with index task_idx. | |||
|
|
|||
| NOTE: When dynamic block splitting is enabled, returns | |||
| Tuple[ObjectRef[ObjectRefGenerator], None] instead of | |||
| Tuple[ObjectRef[DynamicObjectRefGenerator], None] instead of | |||
There was a problem hiding this comment.
cc @raulchen is this still relevant with data?
There was a problem hiding this comment.
this code path is being deprecated.
|
@pcmoritz @ericl this PR will have a breaking change to num_returns="dynamic" because it changes the name of the class to ObjectRefGenerator -> DynamicObjectRefGenerator, so that If this is concerning, we can instead use |
jjyao
approved these changes
Nov 29, 2023
edoakes
approved these changes
Nov 29, 2023
| @@ -233,7 +233,7 @@ def _send_query_java(self, query: Query) -> ray.ObjectRef: | |||
|
|
|||
| def _send_query_python( | |||
| self, query: Query | |||
| ) -> Union[ray.ObjectRef, "ray._raylet.StreamingObjectRefGenerator"]: | |||
| ) -> Union[ray.ObjectRef, "ray._raylet.ObjectRefGenerator"]: | |||
| """Send the query to a Python replica.""" | |||
| if query.metadata.is_streaming: | |||
| method = self._actor_handle.handle_request_streaming.options( | |||
There was a problem hiding this comment.
I believe you can/should remove the num_returns="streaming" here
raulchen
approved these changes
Nov 29, 2023
angelinalg
approved these changes
Nov 29, 2023
ericl
added
the
@author-action-required
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?
This is the second PR of 3 steps.
All sort of implementation work [done]
Rename StreamingObjectRefGenerator and annotate it as a public API (and move it to init.py) <---- this PR
Typing support [future]
This PR renames StreamingObjectRefGenerator - > ObjectRefGenerator. This also means the existing dynamic generator's (num_returns="dynamic") return type will become ObjectRefGenerator -> DynamicObjectRefGenerator, which is a breaking change, but we will anyway deprecate this API. I am open for a different name if we'd like to keep the perfect backward compatibility.
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.