[Doc] [runtime env] Move runtime env section up one level, add inbound links #19863
Conversation
| cluster environment. | ||
|
|
||
| .. _runtime-environments: | ||
|
|
There was a problem hiding this comment.
The content below this line has only been moved from the previous location in this PR.
| ===================== | ||
|
|
||
| Your Ray project may depend on environment variables, local files, and Python packages. | ||
| Ray makes managing these dependencies easy, even when working with a remote cluster. |
There was a problem hiding this comment.
Make the language neutral -- don't say "X makes something easy", say "X has Y functionality to do ABC"
| Dependency Management | ||
| ===================== | ||
|
|
||
| Your Ray project may depend on environment variables, local files, and Python packages. |
There was a problem hiding this comment.
Ray script or program?
There was a problem hiding this comment.
but yeah "project" is fluffy
| Your Ray project may depend on environment variables, local files, and Python packages. | ||
| Ray makes managing these dependencies easy, even when working with a remote cluster. | ||
|
|
||
| You can specify dependencies dynamically at runtime using :ref:`Runtime Environments<runtime-environments>`. This is useful for quickly iterating on a project with changing dependencies and local code files, or for running jobs, tasks and actors with different environments all on the same Ray cluster. |
There was a problem hiding this comment.
I think you need to have a section for concepts. What is a Runtime Environment?
What is local code files?
| @@ -0,0 +1,127 @@ | |||
| .. _dependency_management: | |||
|
|
|||
| Dependency Management | |||
There was a problem hiding this comment.
rename to "Handling dependencies"?
There was a problem hiding this comment.
Maybe not in this PR, but by the time you are done, a good metric of success is that all questions about dependency management can be answered by linking to the Ray docs.
For example, https://stackoverflow.com/questions/69765007/how-does-ray-handle-package-dependencies
|
Anyways, this is looking quite good! |
There was a problem hiding this comment.
This will go a long way! I think next we should add some more "guide"-style content to the section as Richard suggested (e.g., concepts, intended workflows). Happy to merge this as a starting point, give me the green light @architkulkarni once it's good to go.
|
serve test unrelated |
| You can specify dependencies dynamically at runtime using :ref:`Runtime Environments<runtime-environments>`. This is useful for quickly iterating on a project with changing dependencies and local code files, or for running jobs, tasks and actors with different environments all on the same Ray cluster. | ||
|
|
||
| Alternatively, you can prepare your Ray cluster's environment once, when your cluster nodes start up. This can be | ||
| accomplished using ``setup_commands`` in the Ray Cluster launcher; see the :ref:`documentation<cluster-configuration-setup-commands>` for details. |
There was a problem hiding this comment.
I think we should have more comments on this part. Like how workers share the env (it inherits env var from ray start for example) or how files & deps are synced across cluster.
There was a problem hiding this comment.
Agree, we definitely need to include more here. For the second thing are you talking about ray rsync? And besides what you mentioned, are there other comments you can think of? If you provide some bullet points or a list of topics, I can flesh it out in the next PR.
Address followup comments from #19863 - Add short "Concepts" section - Add more section headings to break up the text - Add "Workflow: Local Files" example - Add "Workflow: Library development" example
Address followup comments from #19863 - Add short "Concepts" section - Add more section headings to break up the text - Add "Workflow: Local Files" example - Add "Workflow: Library development" example
Address followup comments from #19863 - Add short "Concepts" section - Add more section headings to break up the text - Add "Workflow: Local Files" example - Add "Workflow: Library development" example
Address followup comments from #19863 - Add short "Concepts" section - Add more section headings to break up the text - Add "Workflow: Local Files" example - Add "Workflow: Library development" example
This is the initial PR for the runtime env docs revision. The goal is to increase adoption by making it more prominent in the docs. There will be several followup PRs.
This PR moves the runtime env doc section up one level, so it now appears in the sidebar. The name "Dependency Management" is recognizable to people who haven't used Ray before.
Prior to this, the section was under the "Advanced" section under the heading "Runtime Environments".
The actual content of the Runtime Environments section is unchanged in this PR. It will be revised in a future PR, along with adding more examples.
The Dependency Management section also includes some words about
setup_commands; this can be expanded in a future PR.This PR also adds several links to the Runtime Environments section from places in the docs where interested users might find themselves, including the Cluster launcher section, Task Resources and Actor Resources sections.
Checks
scripts/format.shto lint the changes in this PR.