Updated internal dev guidelines #2296
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the internal development guidelines to reflect changes in the ray_run.py command-line interface parameters. The documentation now uses the current parameter syntax and adds a helpful command for viewing job logs.
Key Changes
- Updated
ray_run.pycommand to use--clusterparameter and shortened-eflag for environment variables - Added
ray job logscommand to help developers view logs for specific jobs - Updated the path to the example script from
experiments/hello_world.pytoexperiments/tutorials/hello_world.py
rjpower
approved these changes
Jan 7, 2026
Collaborator
rjpower
left a comment
rjpower
left a comment
There was a problem hiding this comment.
thanks for the cleanup!
| uv run scripts/ray/cluster.py --config infra/marin-us-central1.yaml list-jobs | ||
| # Get Job Logs for a specific job | ||
| ray job logs --address "http://127.0.0.1:8265" <JOB_ID> |
Collaborator
There was a problem hiding this comment.
For this, let's make sure the user know they should connect to the dashboard first:
# connect to dashboard
# `uv run ...cluster.py dashboard`
ray job logs...
Author
There was a problem hiding this comment.
Updated to this!
# Get Job Logs for a specific job
# Ensure that the dashboard for the correct cluster is running (run this in another terminal)
# > uv run scripts/ray/cluster.py --config infra/marin-us-central1.yaml dashboard
ray job logs --address "http://127.0.0.1:8265" <JOB_ID>Thanks for the suggestion!
XenonMolecule
force-pushed
the
fix-dev-guidelines
branch
from
b0ec6aa to
0f8ea1c
Compare
XenonMolecule
force-pushed
the
fix-dev-guidelines
branch
from
0f8ea1c to
e08dae0
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
While I was onboarding to Marin I noticed that some of the parameters to ray_run have changed. I updated the commands in the tutorial to reflect the changes I observed.
Before:
uv run lib/marin/src/marin/run/ray_run.py --no_wait --env_vars WANDB_API_KEY=${WANDB_API_KEY} -- python experiments/hello_world.pyAfter
uv run lib/marin/src/marin/run/ray_run.py --cluster infra/marin-us-central1.yaml --no_wait -e WANDB_API_KEY ${WANDB_API_KEY} -- python experiments/tutorials/hello_world.pyFor testing I also personally found it valuable to view the logs for a run so I added this line to the tutorial:
I would appreciate if a maintainer more familiar with the cluster/ray would double check that this is the recommended way of doing this!