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 ApplicationStatus class to API docs (#34966) #48207

Conversation

akyang-anyscale
Copy link
Contributor

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

Why are these changes needed?

This PR moves the ApplicationStatus class out of the _private directory, allowing it to be included in the API docs.

Related issue number

#34966

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

akyang-anyscale and others added 2 commits October 22, 2024 18:09
…erview classes to API docs

Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Ray debugger CLI (`ray debug`) is useful but when you have multiple
tasks in the breakpoint, and they are of the same task function, one can
have difficulties understanding which is which.

Add "Node ID", "Worker ID", "Actor ID", "Task ID" to the breakpoint info
so in `ray debug` these IDs show up in the breakpoint selection menu.
This helps users disambiguate between active breakpoints.

The new fields are gated by `-v` or `--verbose`.

Signed-off-by: Ruiyang Wang <rywang014@gmail.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
@akyang-anyscale akyang-anyscale force-pushed the alexyang/serve-application-status branch from 21cddd8 to 82778f4 Compare October 23, 2024 01:09
@akyang-anyscale akyang-anyscale changed the title [Serve] Expose ApplicationStatus, ApplicationStatusInfo, and StatusOverview classes to API docs (#34966) [Serve] Expose ApplicationStatus class to API docs (#34966) Oct 23, 2024
@akyang-anyscale akyang-anyscale deleted the alexyang/serve-application-status branch October 23, 2024 18:40
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.

2 participants