[Serve] support -h to serve cli #35754
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
* also added serve symlink to setup-dev.py script issue: ray-project#35734 Signed-off-by: Gene Su <e870252314@gmail.com>
edoakes
reviewed
May 25, 2023
python/ray/setup-dev.py
Outdated
| @@ -122,6 +122,7 @@ def do_link(package, force=False, skip_list=None, local_path=None): | |||
| skip_list=args.skip, | |||
| local_path="../../../dashboard", | |||
| ) | |||
| do_link("serve", force=args.yes, skip_list=args.skip) | |||
There was a problem hiding this comment.
Could you please do this in a separate PR? Better to keep things orthogonal where possible, makes it easier to track down issues if they happen.
In this case it's minor, but better to be disciplined about it.
There was a problem hiding this comment.
np, let me take this part out and open a separate PR
Signed-off-by: Gene Su <e870252314@gmail.com>
GeneDer
force-pushed
the
add--h-help-docstring
branch
from
e6728c3
to
8ed6643
Compare
edoakes
approved these changes
May 25, 2023
python/ray/serve/scripts.py
Outdated
| @click.group(help="CLI for managing Serve applications on a Ray cluster.") | ||
| @click.group( | ||
| help="CLI for managing Serve applications on a Ray cluster.", | ||
| context_settings=CONTEXT_SETTINGS, |
There was a problem hiding this comment.
[Nit] Could you pass in the CONTEXT_SETTING dictionary directly instead of using a constant? Afaik, this dictionary is only used in this argument, so I don't think it needs to be stored as a global constant.
Signed-off-by: Gene Su <e870252314@gmail.com>
scv119
pushed a commit
to scv119/ray
that referenced
this pull request
Jun 16, 2023
`-h` is a common pattern and is not currently supported on `serve` cli. This PR adds the support to call `serve -h`
8 tasks
edoakes
pushed a commit
that referenced
this pull request
Jul 27, 2023
Re: #35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages.
8 tasks
edoakes
pushed a commit
to edoakes/ray
that referenced
this pull request
Aug 2, 2023
Re: ray-project#35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages. Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
rickyyx
pushed a commit
that referenced
this pull request
Aug 8, 2023
Re: #35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages. Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com> Co-authored-by: Gene Der Su <e870252314@gmail.com>
NripeshN
pushed a commit
to NripeshN/ray
that referenced
this pull request
Aug 15, 2023
Re: ray-project#35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages. Signed-off-by: NripeshN <nn2012@hw.ac.uk>
arvind-chandra
pushed a commit
to lmco/ray
that referenced
this pull request
Aug 31, 2023
`-h` is a common pattern and is not currently supported on `serve` cli. This PR adds the support to call `serve -h` Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
arvind-chandra
pushed a commit
to lmco/ray
that referenced
this pull request
Aug 31, 2023
Re: ray-project#35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages. Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
vymao
pushed a commit
to vymao/ray
that referenced
this pull request
Oct 11, 2023
Re: ray-project#35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages. Signed-off-by: Victor <vctr.y.m@example.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?
-his a common pattern and is not currently supported onservecli. This PR adds the support to callserve -hRelated issue number
Closes #35734
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.python python/ray/setup-dev.py -ythen seeingserve -hworking