[Doc] Make runtimeEnvYAML more prominent in docs #44326
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
Signed-off-by: Archit Kulkarni <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
architkulkarni
requested review from
maxpumperla,
pcmoritz,
kevin85421 and
a team
as code owners
|
The CI test |
architkulkarni
added
the
@author-action-required
kevin85421
approved these changes
Mar 29, 2024
Rendering looks OK, merging.
|
architkulkarni
removed
the
@author-action-required
angelinalg
approved these changes
Apr 1, 2024
doc/source/cluster/kubernetes/getting-started/rayjob-quick-start.md
Outdated
Show resolved
Hide resolved
| * `runtimeEnvYAML` (Optional): A runtime environment that describes the dependencies the Ray job needs to run, including files, packages, environment variables, and more. Provide the configuration as a multi-line YAML string. Example: | ||
|
|
||
| ```yaml | ||
| # [...] |
There was a problem hiding this comment.
Not sure if this adds any value. Is there some pseudo comment that would make this more useful? If not and this is common practice, then please disregard my comment.
There was a problem hiding this comment.
Not sure either. I don't feel strongly about it so I removed it
…rt.md Co-authored-by: angelinalg <[email protected]> Signed-off-by: Archit Kulkarni <[email protected]>
ryanaoleary
pushed a commit
to ryanaoleary/ray
that referenced
this pull request
Jun 7, 2024
When using Ray Jobs, it's better to specify the runtime_env in the Job spec, rather than in ray.init() in the entrypoint script. The reason is that it's simpler; in the first case the entrypoint script runs in the runtime env (as well as any tasks/actors), whereas in the second case only the tasks and actors run in the runtime env. Some users are still using runtime_env in ray.init(). One possible reason is that it's not prominent enough in the docs. This PR adds a reference to KubeRay RayJob in the Ray Core runtime env docs, and also adds a code snippet to make it more friendly for users to copy and paste. --------- Signed-off-by: Archit Kulkarni <[email protected]> Co-authored-by: angelinalg <[email protected]>
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?
When using Ray Jobs, it's better to specify the
runtime_envin the Job spec, rather than inray.init()in the entrypoint script. The reason is that it's simpler; in the first case the entrypoint script runs in the runtime env (as well as any tasks/actors), whereas in the second case only the tasks and actors run in the runtime env.Some users are still using
runtime_envinray.init(). One possible reason is that it's not prominent enough in the docs. This PR adds a reference to KubeRay RayJob in the Ray Core runtime env docs, and also adds a code snippet to make it more friendly for users to copy and paste.Related issue number
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.