[Serve] Expose ApplicationStatus class to API docs (#34966) #48220
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
…erview classes to API docs 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>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
edoakes
approved these changes
Oct 23, 2024
|
Looks like a couple annotations are still missing: https://buildkite.com/ray-project/microcheck/builds/6362#0192bb23-7c79-4009-898b-cd8969cf276f/184-476 |
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
|
I actually rather not have |
zcin
approved these changes
Oct 24, 2024
python/ray/serve/schema.py
Outdated
| @PublicAPI(stability="alpha") | ||
| @dataclass | ||
| class ApplicationStatusOverview: | ||
| """Describes the status of an application and all its deployments. | ||
| """Describes the satus of an application and all its deployments. |
There was a problem hiding this comment.
Suggested change
| """Describes the satus of an application and all its deployments. | |
| """Describes the status of an application and all its deployments. |
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Jay-ju
pushed a commit
to Jay-ju/ray
that referenced
this pull request
Nov 5, 2024
ray-project#48220) ## 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 Closes ray-project#34966 --------- 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
ray-project#48220) ## 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 Closes ray-project#34966 --------- Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
mohitjain2504
pushed a commit
to mohitjain2504/ray
that referenced
this pull request
Nov 15, 2024
ray-project#48220) ## 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 Closes ray-project#34966 --------- 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
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 PR moves the ApplicationStatus class out of the _private directory, allowing it to be included in the API docs.
Related issue number
Closes #34966
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.