ray-project / ray

Ray is a unified framework for scaling AI and Python applications. Ray consists of a core distributed runtime and a set of AI Libraries for accelerating ML workloads.
https://ray.io
Apache License 2.0
33.3k stars 5.63k forks source link

[core] Document/improve how to pass system configs #42197

Open stephanie-wang opened 9 months ago

stephanie-wang commented 9 months ago

Description

Some system configs like object spilling directory are quite difficult to override, and we are also not consistent about documenting the system configs.

For example, you may have to specify a system config like this to override object spilling directory:

system-config: '"{\"object_spilling_config\":\"{\\\"type\\\":\\\"filesystem\\\",\\\"params\\\":{\\\"directory_path\\\":\\\"/tmp/spill\\\"}}\"}"'

Ideally we should automatically generate docs from the config def file and have an easier way to pass JSON-like configs.

Use case

No response

dizhouwu commented 5 months ago

def would be useful to users!