Skip to content

Updated internal dev guidelines #2296

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

Open
XenonMolecule wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updated internal dev guidelines #2296

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e79ebc
Updated internal dev guidelines
XenonMolecule Jan 7, 2026
e08dae0
Docs:Clarify dashboard run for ray logs
XenonMolecule Jan 7, 2026
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
7 changes: 6 additions & 1 deletion docs/dev-guide/guidelines-internal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,16 @@ launching tasks -- see [test_integration_test.py](https://github.com/marin-commu
```bash
# [Terminal 2] Submit a Ray Job (specified via a Python script)
# =>> Will output a Job ID like `raysubmit_pAJM8vKfHPhiyHBa`
uv run lib/marin/src/marin/run/ray_run.py --no_wait --env_vars WANDB_API_KEY=${WANDB_API_KEY} -- python experiments/hello_world.py
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.py

# Get Job Status
uv run scripts/ray/cluster.py --config infra/marin-us-central1.yaml list-jobs

# 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>
Copy link
Collaborator

@rjpower rjpower Jan 7, 2026

Choose a reason for hiding this comment

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

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...

Copy link
Author

@XenonMolecule XenonMolecule Jan 7, 2026

Choose a reason for hiding this comment

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

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!


# Kill / Stop Job (if necessary / error / bug)
uv run scripts/ray/cluster.py --config infra/marin-us-central1.yaml stop-job raysubmit_pAJM8vKfHPhiyHBa
```