-
Notifications
You must be signed in to change notification settings - Fork 6k
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
[Doc] Add improved 'ray start --resources' help #41009
[Doc] Add improved 'ray start --resources' help #41009
Conversation
Maybe a triple-quoted string could be used to preserve line formatting, and with a touch of dedent to make it pretty? Also, note this is for the windows cmd command prompt. For powershell, additional escaping is needed. Maybe all this should only be added to the help text for windows, to give posix users less of an opportunity to laugh at windows users.
|
de10038
to
254fc3d
Compare
254fc3d
to
8e26289
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I confirmed the change only happens on windows. FWIW, the help looks like
--resources TEXT A JSON serialized dictionary mapping
resource name to resource quantity.
Windows command prompt users must ensure to
double quote command line arguments; since
JSON requires the use of double quotes these
must be escaped as well, e.g.
ray start --head
--resources="{\"special_hardware\":1,
\"custom_label\":1}"
Windows powershell users need additional
escaping:
ray start --head
--resources="{\""special_hardware\"":1,
\""custom_label\"":1}"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some style nits.
Signed-off-by: pdmurray <peynmurray@gmail.com>
f4d145d
to
c104901
Compare
@jjyao Would you be able to merge this? |
This PR clarifies usage of ray start --resources and gives an example of valid usage on Windows. Signed-off-by: pdmurray <peynmurray@gmail.com>
Why are these changes needed?
This PR clarifies usage of
ray start --resources
and gives an example of valid usage on Windows.Related issue number
Closes #34818.
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.