[Serve] Make public all of the type hints that are used by the serve.status() API #43394
Assignees
Labels
enhancement
Request for new feature and/or capability
P1.5
Issues that will be fixed in a couple releases. It will be bumped once all P1s are cleared
serve
Ray Serve Related Issue
Comments
hangg112233
added
enhancement
GeneDer
added
P1.5
8 tasks
Jay-ju
pushed a commit
to Jay-ju/ray
that referenced
this issue
Nov 5, 2024
…-project#48299) ## Why are these changes needed? <!-- Please give a short summary of the change and the problem this solves. --> This PR moves `ProxyStatus` out of the `_private` directory, allowing it to be included in the API docs. This is the final attribute of `ServeStatus` that needs to be included in the documentation. ## Related issue number <!-- For example: "Closes ray-project#1234" --> Closes ray-project#43394 --------- Signed-off-by: akyang-anyscale <[email protected]>
JP-sDEV
pushed a commit
to JP-sDEV/ray
that referenced
this issue
Nov 14, 2024
…-project#48299) ## Why are these changes needed? <!-- Please give a short summary of the change and the problem this solves. --> This PR moves `ProxyStatus` out of the `_private` directory, allowing it to be included in the API docs. This is the final attribute of `ServeStatus` that needs to be included in the documentation. ## Related issue number <!-- For example: "Closes ray-project#1234" --> Closes ray-project#43394 --------- Signed-off-by: akyang-anyscale <[email protected]>
mohitjain2504
pushed a commit
to mohitjain2504/ray
that referenced
this issue
Nov 15, 2024
…-project#48299) ## Why are these changes needed? <!-- Please give a short summary of the change and the problem this solves. --> This PR moves `ProxyStatus` out of the `_private` directory, allowing it to be included in the API docs. This is the final attribute of `ServeStatus` that needs to be included in the documentation. ## Related issue number <!-- For example: "Closes ray-project#1234" --> Closes ray-project#43394 --------- Signed-off-by: akyang-anyscale <[email protected]> Signed-off-by: mohitjain2504 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
Currently,
serve.status()returns aServeStatusclass type which is a Public API. However,ServeStatushas children/descendants whose types are not part of the Public API, such asProxyStatusandApplicationStatus.As a result, when a user wants to use the
ServeStatustype hint, they must also import additional type hints fromray.serve._private.It would be great if all of these types are part of the Public API, so that I do not have to import from
ray.serve._private.common.Use case
With this change, I would not have to import from the
ray.serve._privatemodule when using theServeStatustype hint.The text was updated successfully, but these errors were encountered: