[Jobs] Update CLI examples to use the same setup #20844
Conversation
| @@ -64,6 +64,8 @@ We can put this file in a local directory of your choice, with filename "script. | |||
|
|
|||
| .. code-block:: bash | |||
|
|
|||
| export RAY_RUNTIME_ENV_LOCAL_DEV_MODE="1" # If you're using locally build version of ray | |||
There was a problem hiding this comment.
please don't add this to public docs, this is an internal developer feature
There was a problem hiding this comment.
I initial tried without using this flag but got stuck on setting up runtime env after submitting a job, and ray log's runtime_env mentions setting this to 1. Can we assume readers of this doc always use a public release ? Not sure if it's common that external ray developers are using v2.0.0dev
There was a problem hiding this comment.
cc: @architkulkarni i remember you told me about setting this flag in case user is using runtime_env pip install with v2.0.0dev
There was a problem hiding this comment.
Ah yeah I think we should assume users are using a released version and at most add a small footnote for people who aren't
There was a problem hiding this comment.
Yeah, that flag is only necessary when using runtime env locally built from source. You don't need it when using any pre-built Ray wheel, including the nightly wheels, even though these are v2.0.0dev. (Basically any wheel that has ray.__commit__ set which can be downloaded from our AWS bucket using the standard URL format.). This is useful because users do often use nightly wheels to get certain bugfixes. (I think it's significantly rarer for them to build from source)
edoakes
added
the
@author-action-required
|
ping @jiaodong to remove env var then LGTM |
Why are these changes needed?
Current docs https://docs.ray.io/en/master/ray-job-submission/overview.html started with CLI but is a very minimal example. This changes it to the better script.py one, same for SDK.
Related issue number
Closes #20835
Checks
scripts/format.shto lint the changes in this PR.