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] Expose ProxyStatus class to API docs (#43394) #48299

Merged
merged 8 commits into from
Oct 30, 2024

Conversation

akyang-anyscale
Copy link
Contributor

@akyang-anyscale akyang-anyscale commented Oct 28, 2024

Why are these changes needed?

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

Closes #43394

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 added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • 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 :(

Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
@akyang-anyscale akyang-anyscale added the go add ONLY when ready to merge, run all tests label Oct 28, 2024
@akyang-anyscale akyang-anyscale marked this pull request as ready for review October 29, 2024 16:05
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Copy link
Contributor

@edoakes edoakes left a comment

Choose a reason for hiding this comment

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

LGTM but lint is failing

You know how to run it locally, right? (just checking)

@akyang-anyscale
Copy link
Contributor Author

LGTM but lint is failing

You know how to run it locally, right? (just checking)

I think it could be unrelated to the changes in this PR. The error is in router.py, which this doesn't touch. Lint is ./scripts/format.sh right?

@zcin
Copy link
Contributor

zcin commented Oct 29, 2024

Oh I think somehow I introduced this ... not sure how but probably outdated master on one of my PRs

@zcin
Copy link
Contributor

zcin commented Oct 29, 2024

#48322

Copy link
Contributor

@GeneDer GeneDer left a comment

Choose a reason for hiding this comment

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

:shipit:

Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
@zcin zcin merged commit bb4efd5 into ray-project:master Oct 30, 2024
5 checks passed
@akyang-anyscale akyang-anyscale deleted the alexyang/serve-status-public branch October 30, 2024 04:24
Jay-ju pushed a commit to Jay-ju/ray that referenced this pull request 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 <alexyang@anyscale.com>
JP-sDEV pushed a commit to JP-sDEV/ray that referenced this pull request 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 <alexyang@anyscale.com>
mohitjain2504 pushed a commit to mohitjain2504/ray that referenced this pull request 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 <alexyang@anyscale.com>
Signed-off-by: mohitjain2504 <mohit.jain@dream11.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go add ONLY when ready to merge, run all tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Serve] Make public all of the type hints that are used by the serve.status() API
4 participants