ray/doc/source
Guyang Song eb2692cb32
[runtime env] runtime env inheritance refactor (#24538)
* [runtime env] runtime env inheritance refactor (#22244)

Runtime Environments is already GA in Ray 1.6.0. The latest doc is [here](https://docs.ray.io/en/master/ray-core/handling-dependencies.html#runtime-environments). And now, we already supported a [inheritance](https://docs.ray.io/en/master/ray-core/handling-dependencies.html#inheritance) behavior as follows (copied from the doc):
- The runtime_env["env_vars"] field will be merged with the runtime_env["env_vars"] field of the parent. This allows for 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.
- Every other field in the runtime_env will be overridden by the child, not merged. For example, if runtime_env["py_modules"] is specified, it will replace the runtime_env["py_modules"] field of the parent.

We think this runtime env merging logic is so complex and confusing to users because users can't know the final runtime env before the jobs are run.

Current PR tries to do a refactor and change the behavior of Runtime Environments inheritance. Here is the new behavior:
- **If there is no runtime env option when we create actor, inherit the parent runtime env.**
- **Otherwise, use the optional runtime env directly and don't do the merging.**

Add a new API named `ray.runtime_env.get_current_runtime_env()` to get the parent runtime env and modify this dict by yourself. Like:
```Actor.options(runtime_env=ray.runtime_env.get_current_runtime_env().update({"X": "Y"}))```
This new API also can be used in ray client.
2022-05-20 10:53:54 +08:00
..
_includes [docs] fix includes for md files (#23180) 2022-03-15 11:09:18 +00:00
_static [air/docs] Move some examples from ml/examples to docs (#24959) 2022-05-19 14:01:49 +01:00
_templates [docs] templates and contribution guide (fixes #21753) (#23003) 2022-03-10 15:28:07 +00:00
cluster Bump Ray Version from 2.0.0.dev0 to 3.0.0.dev0 (#24894) 2022-05-17 19:31:05 -07:00
data [Datasets] Add FAQ to Datasets docs. (#24932) 2022-05-19 15:44:22 -07:00
images [Datasets] Add basic e2e Datasets example on NYC taxi dataset (#24874) 2022-05-19 12:54:25 -07:00
ray-air [docs] Add AIR data ingest docs (part 1-- bulk loading only) (#24799) 2022-05-19 14:25:47 -07:00
ray-contribute Bump Ray Version from 2.0.0.dev0 to 3.0.0.dev0 (#24894) 2022-05-17 19:31:05 -07:00
ray-core [runtime env] runtime env inheritance refactor (#24538) 2022-05-20 10:53:54 +08:00
ray-more-libs [docs] Add initial AIR documentation (#24483) 2022-05-13 01:29:59 -07:00
ray-observability [docs] Document log to driver = False 2022-05-19 15:07:30 -07:00
ray-overview [docs] Remove link do Windows py 3.6 wheels (#24954) 2022-05-19 08:40:14 +01:00
ray-references [docs] Add initial AIR documentation (#24483) 2022-05-13 01:29:59 -07:00
rllib [RLlib] Agents to algos: DQN w/o Apex and R2D2, DDPG/TD3, SAC, SlateQ, QMIX, PG, Bandits (#24896) 2022-05-19 18:30:42 +02:00
serve [Serve] Alias ray.serve.dag.InputNode (#24630) 2022-05-17 22:35:51 -07:00
train [Train] Fully deprecate Ray SGD v1 (#24038) 2022-04-25 16:12:57 -07:00
tune [docs] Remove bad suggestions to use local_mode or num_cpus in init (#24827) 2022-05-17 12:55:04 -07:00
workflows [workflow] Update workflow doc and examples (#24804) 2022-05-16 15:41:14 -07:00
_toc.yml [Datasets] Add FAQ to Datasets docs. (#24932) 2022-05-19 15:44:22 -07:00
conf.py [docs] add robots txt (#24726) 2022-05-18 10:52:22 +01:00
custom_directives.py [docs] Restore external markdown stubs (#24357) 2022-05-02 15:37:40 +01:00
index.md [minor] Fix incorrect link to ray core user guide (#23316) 2022-03-17 20:58:56 -07:00
preprocess_github_markdown.py [Docs] Automatically render latest ray_lightning docs (#23729) 2022-04-08 16:57:23 -07:00
robots.txt [docs] add robots txt (#24726) 2022-05-18 10:52:22 +01:00