Skip to content

chore: update ray wrapper docs #1008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DefTruth merged 1 commit into from
May 12, 2026
+4 −2
Merged

chore: update ray wrapper docs #1008

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/user_guide/RAY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,8 @@ When your application code (custom pipeline classes, helper modules) lives in a
Cache-DiT exposes `ParallelismConfig.ray_runtime_env` to pass a Ray `runtime_env` dictionary to `ray.init()`. The most common and **lightweight** pattern is to use `env_vars` to set `PYTHONPATH`:

```python
import os

cache_dit.enable_cache(
pipe,
parallelism_config=ParallelismConfig(
Expand All @@ -168,7 +170,7 @@ cache_dit.enable_cache(
ray_runtime_env={
# Single or multiple paths can be added, separated by ":" or " "
"env_vars": {
"PYTHONPATH": "/path/to/your/app/src",
"PYTHONPATH": f"/path/to/your/app/src:{os.environ.get('PYTHONPATH', '')}",
# "PYTHONPATH": "xxx/path1:xxx/path2:xxx/path3",
}
},
Expand All @@ -181,7 +183,7 @@ cache_dit.enable_cache(
`PYTHONPATH` is a Python environment variable that specifies additional directories where Python searches for modules. When Python starts, it appends each `:`-separated path in `PYTHONPATH` to `sys.path`, before the standard-library and site-packages entries. Multiple paths are supported:

```python
"PYTHONPATH": "/app/src:/app/libs:/shared/utils"
"PYTHONPATH": f"/app/src:/app/libs:/shared/utils:{os.environ.get('PYTHONPATH', '')}"
```

Ray workers receive `env_vars` entries as process environment variables — **nothing is packaged, zipped, or uploaded**. Workers resolve `import your_module` directly from the filesystem path. `env_vars` vs `working_dir` / `py_modules` listed as below:
Expand Down
Loading