mirror of
https://github.com/vale981/ray
synced 2025-03-06 02:21:39 -05:00
[doc] [runtime_env] Remove "experimental" label, add beta stability annotation (#17651)
This commit is contained in:
parent
c62ce78be8
commit
bbcb06d45b
3 changed files with 13 additions and 9 deletions
|
@ -425,12 +425,12 @@ To get information about the current available resource capacity of your cluster
|
|||
|
||||
.. _runtime-environments:
|
||||
|
||||
Runtime Environments (Experimental)
|
||||
Runtime Environments
|
||||
-----------------------------------
|
||||
|
||||
.. note::
|
||||
|
||||
Runtime environments are currently an experimental feature and under active development. The API is subject to change.
|
||||
This API is in beta and may change before becoming stable.
|
||||
|
||||
On Mac OS and Linux, Ray 1.4+ supports dynamically setting the runtime environment of tasks, actors, and jobs so that they can depend on different Python libraries (e.g., conda environments, pip dependencies) while all running on the same Ray cluster.
|
||||
|
||||
|
@ -492,7 +492,7 @@ The ``runtime_env`` is a Python dictionary including one or more of the followin
|
|||
|
||||
- ``conda`` (dict | str): Either (1) a dict representing the conda environment YAML, (2) a string containing the path to a
|
||||
`conda “environment.yml” <https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#create-env-file-manually>`_ file,
|
||||
or (3) the name of a local conda env already installed on each node in your cluster (e.g., ``"pytorch_p36"``).
|
||||
or (3) the name of a local conda environment already installed on each node in your cluster (e.g., ``"pytorch_p36"``).
|
||||
In the first two cases, the Ray and Python dependencies will be automatically injected into the environment to ensure compatibility, so there is no need to manually include them.
|
||||
Note that the ``conda`` and ``pip`` keys of ``runtime_env`` cannot both be specified at the same time---to use them together, please use ``conda`` and add your pip dependencies in the ``"pip"`` field in your conda ``environment.yaml``.
|
||||
|
||||
|
@ -508,14 +508,14 @@ The ``runtime_env`` is a Python dictionary including one or more of the followin
|
|||
|
||||
- Example: ``{"OMP_NUM_THREADS": "32", "TF_WARNINGS": "none"}``
|
||||
|
||||
The runtime env is inheritable, so it will apply to all tasks/actors within a job and all child tasks/actors of a task or actor, once set.
|
||||
The runtime environment is inheritable, so it will apply to all tasks/actors within a job and all child tasks/actors of a task or actor, once set.
|
||||
|
||||
If a child actor or task specifies a new ``runtime_env``, it will be merged with the parent’s ``runtime_env`` via a simple dict update.
|
||||
For example, if ``runtime_env["pip"]`` is specified, it will override the ``runtime_env["pip"]`` field of the parent.
|
||||
The one exception is the field ``runtime_env["env_vars"]``. This field will be `merged` with the ``runtime_env["env_vars"]`` dict of the parent.
|
||||
This allows for an environment variables set in the parent's runtime environment to be automatically propagated to the child, even if new environment variables are set in the child's runtime environment.
|
||||
|
||||
Here are some examples of runtime envs combining multiple options:
|
||||
Here are some examples of runtime environments combining multiple options:
|
||||
|
||||
..
|
||||
TODO(architkulkarni): run working_dir doc example in CI
|
||||
|
|
|
@ -548,8 +548,9 @@ class ActorClass:
|
|||
of this actor should implicitly use the same placement group
|
||||
as its parent. It is True by default.
|
||||
runtime_env (Dict[str, Any]): Specifies the runtime environment for
|
||||
this actor or task and its children (see ``runtime_env.py`` for
|
||||
more details).
|
||||
this actor or task and its children (see
|
||||
:ref:`runtime-environments` for details). This API is in beta
|
||||
and may change before becoming stable.
|
||||
override_environment_variables: Environment variables to override
|
||||
and/or introduce for this actor. This is a dictionary mapping
|
||||
variable names to their values.
|
||||
|
|
|
@ -696,7 +696,9 @@ def init(
|
|||
log_to_driver (bool): If true, the output from all of the worker
|
||||
processes on all nodes will be directed to the driver.
|
||||
namespace (str): Namespace to use
|
||||
runtime_env (dict): The runtime environment to use for this job.
|
||||
runtime_env (dict): The runtime environment to use for this job (see
|
||||
:ref:`runtime-environments` for details). This API is in beta
|
||||
and may change before becoming stable.
|
||||
_enable_object_reconstruction (bool): If True, when an object stored in
|
||||
the distributed plasma store is lost due to node failure, Ray will
|
||||
attempt to reconstruct the object by re-executing the task that
|
||||
|
@ -2067,7 +2069,8 @@ def remote(*args, **kwargs):
|
|||
infinite retries.
|
||||
runtime_env (Dict[str, Any]): Specifies the runtime environment for
|
||||
this actor or task and its children. See
|
||||
:ref:`runtime-environments` for detailed documentation.
|
||||
:ref:`runtime-environments` for detailed documentation. This API is
|
||||
in beta and may change before becoming stable.
|
||||
override_environment_variables (Dict[str, str]): (Deprecated in Ray
|
||||
1.4.0, will be removed in Ray 1.6--please use the ``env_vars``
|
||||
field of :ref:`runtime-environments` instead.) This specifies
|
||||
|
|
Loading…
Add table
Reference in a new issue