Skip to content

[core][docs] Update misleading Ray job diagram#59940

Merged
edoakes merged 8 commits intoray-project:masterfrom
edoakes:eoakes/fix-jobs-diagram
Jan 15, 2026
Merged

[core][docs] Update misleading Ray job diagram#59940
edoakes merged 8 commits intoray-project:masterfrom
edoakes:eoakes/fix-jobs-diagram

Conversation

@edoakes
Copy link
Collaborator

@edoakes edoakes commented Jan 7, 2026

Before:

Screenshot 2026-01-07 at 11 03 26 AM

After:

ray-job-diagram

Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
@edoakes edoakes requested review from a team as code owners January 7, 2026 17:27
@edoakes edoakes added the go add ONLY when ready to merge, run all tests label Jan 7, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the Ray job submission diagram to be more accurate, reflecting two primary ways to run a job instead of three. The change involves replacing the old SVG diagram with a new PNG version and updating the corresponding markdown file. The change is clear and achieves its goal. I've added one suggestion to consider using SVG format for the new diagram for better scalability and quality.

@ray-gardener ray-gardener bot added the core Issues that should be addressed in Ray Core label Jan 7, 2026
Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
@Yicheng-Lu-llll
Copy link
Member

Yicheng-Lu-llll commented Jan 8, 2026

I noticed that in the doc https://docs.ray.io/en/latest/cluster/running-applications/job-submission/index.html, the "Running Jobs Interactively" section still includes Ray Client. However, when using Ray Client, the Python driver runs on the local machine, which may be worth clarifying in the docs.

@edoakes edoakes force-pushed the eoakes/fix-jobs-diagram branch from 20df9ad to 598633f Compare January 8, 2026 22:23
@edoakes
Copy link
Collaborator Author

edoakes commented Jan 9, 2026

I noticed that in the doc https://docs.ray.io/en/latest/cluster/running-applications/job-submission/index.html, the "Running Jobs Interactively" section still includes Ray Client. However, when using Ray Client, the Python driver runs on the local machine, which may be worth clarifying in the docs.

Good call out, but in general we want to de-emphasize using Ray Client. It's listed as "experts only" in that docs page, so I'd prefer to leave it out of the diagram.

@edoakes edoakes requested a review from israbbani January 9, 2026 20:21
@edoakes
Copy link
Collaborator Author

edoakes commented Jan 9, 2026

Manually checked the rendering of the image, looks good

Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
@edoakes edoakes enabled auto-merge (squash) January 15, 2026 18:01
@edoakes edoakes merged commit 65b280a into ray-project:master Jan 15, 2026
7 checks passed
jeffery4011 pushed a commit to jeffery4011/ray that referenced this pull request Jan 20, 2026
Before:

<img width="616" height="210" alt="Screenshot 2026-01-07 at 11 03 26 AM"
src="https://github.com/user-attachments/assets/139496f4-136d-4ade-9ec5-ad788cc4f8f9"
/>

After:

<img width="5000" height="2812" alt="ray-job-diagram"
src="https://github.com/user-attachments/assets/e9c653be-3191-458d-9fa1-30329c395496"
/>

---------

Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
Signed-off-by: jeffery4011 <jefferyshen1015@gmail.com>
ryanaoleary pushed a commit to ryanaoleary/ray that referenced this pull request Feb 3, 2026
Before:

<img width="616" height="210" alt="Screenshot 2026-01-07 at 11 03 26 AM"
src="https://github.com/user-attachments/assets/139496f4-136d-4ade-9ec5-ad788cc4f8f9"
/>

After:

<img width="5000" height="2812" alt="ray-job-diagram"
src="https://github.com/user-attachments/assets/e9c653be-3191-458d-9fa1-30329c395496"
/>

---------

Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
peterxcli pushed a commit to peterxcli/ray that referenced this pull request Feb 25, 2026
Before:

<img width="616" height="210" alt="Screenshot 2026-01-07 at 11 03 26 AM"
src="https://github.com/user-attachments/assets/139496f4-136d-4ade-9ec5-ad788cc4f8f9"
/>

After:

<img width="5000" height="2812" alt="ray-job-diagram"
src="https://github.com/user-attachments/assets/e9c653be-3191-458d-9fa1-30329c395496"
/>

---------

Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
Signed-off-by: peterxcli <peterxcli@gmail.com>
peterxcli pushed a commit to peterxcli/ray that referenced this pull request Feb 25, 2026
Before:

<img width="616" height="210" alt="Screenshot 2026-01-07 at 11 03 26 AM"
src="https://github.com/user-attachments/assets/139496f4-136d-4ade-9ec5-ad788cc4f8f9"
/>

After:

<img width="5000" height="2812" alt="ray-job-diagram"
src="https://github.com/user-attachments/assets/e9c653be-3191-458d-9fa1-30329c395496"
/>

---------

Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
Signed-off-by: peterxcli <peterxcli@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Issues that should be addressed in Ray Core go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants