Skip to content

Commit c20f9c4

Browse files
authored
Add a standalone monitor skill for persistent job tracking (#1252)
### What does this PR do? Type of change: ? <!-- Use one of the following: Bug fix, new feature, new example, new tests, documentation. --> Add a standalone monitor skill for persistent job tracking across sessions, and integrate it with PTQ, evaluation, and deployment skills. Problem: Each skill had ad-hoc inline monitoring (squeue polling, nel status checks) that didn't survive session restarts and couldn't track multiple jobs. Users had to manually ask "check status" every time. Solution: A centralized monitor skill with: - Job registry (.claude/active_jobs.json): single source of truth for all active jobs - Durable recurring cron: polls every 15 min, survives session restarts, self-cleans when all jobs complete - User-initiated mode: works in new conversations by reading the registry - Aggregated reporting: "2 of 4 completed" instead of per-job noise ### Usage After any skill submits a job, the monitor skill automatically: 1. Registers the job in .claude/active_jobs.json 2. Sets up a durable cron to poll status every 15 minutes User can also trigger manually: User: "check my eval status" → reads registry, reports current state User: "is the PTQ done?" → finds job, checks status User: "what jobs are running?" → lists all registered jobs ### Testing <!-- Mention how have you tested your change if applicable. --> ### Before your PR is "*Ready for review*" Make sure you read and follow [Contributor guidelines](https://github.com/NVIDIA/Model-Optimizer/blob/main/CONTRIBUTING.md) and your commits are signed (`git commit -s -S`). Make sure you read and follow the [Security Best Practices](https://github.com/NVIDIA/Model-Optimizer/blob/main/SECURITY.md#security-coding-practices-for-contributors) (e.g. avoiding hardcoded `trust_remote_code=True`, `torch.load(..., weights_only=False)`, `pickle`, etc.). - Is this change backward compatible?: ✅ / ❌ / N/A <!--- If ❌, explain why. --> - If you copied code from any other sources or added a new PIP dependency, did you follow guidance in `CONTRIBUTING.md`: ✅ / ❌ / N/A <!--- Mandatory --> - Did you write any new necessary tests?: ✅ / ❌ / N/A <!--- Mandatory for new features or examples. --> - Did you update [Changelog](https://github.com/NVIDIA/Model-Optimizer/blob/main/CHANGELOG.rst)?: ✅ / ❌ / N/A <!--- Only for new features, API changes, critical bug fixes or backward incompatible changes. --> ### Additional Information <!-- E.g. related issue. --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added monitor skill for tracking SLURM jobs, NEL evaluations, and launcher experiments with persistent job registry. * **Documentation** * Updated deployment, evaluation, and PTQ documentation to use the new monitor skill. * Simplified diagnostic and troubleshooting instructions. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Kai Xu <kaix@nvidia.com>
1 parent e9a4989 commit c20f9c4

4 files changed

Lines changed: 120 additions & 60 deletions

File tree

.claude/skills/deployment/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ If a cluster config exists (`~/.config/modelopt/clusters.yaml` or `.claude/clust
195195

196196
3. **Deploy based on remote environment:**
197197

198-
- **SLURM** — see `skills/common/slurm-setup.md` for job script templates (container setup, account/partition discovery). The server command inside the container is the same as Step 4 (e.g., `python -m vllm.entrypoints.openai.api_server --model <path> --quantization modelopt`). Use `remote_submit_job` and `remote_poll_job` to manage the job. Get the node hostname from `squeue -j $JOBID -o %N`.
198+
- **SLURM** — see `skills/common/slurm-setup.md` for job script templates (container setup, account/partition discovery). The server command inside the container is the same as Step 4 (e.g., `python -m vllm.entrypoints.openai.api_server --model <path> --quantization modelopt`). After submitting, register the job and set up monitoring per the **monitor skill**. Get the node hostname from `squeue -j $JOBID -o %N`.
199199

200200
- **Bare metal / Docker** — use `remote_run` to start the server directly:
201201

.claude/skills/evaluation/SKILL.md

Lines changed: 16 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -256,64 +256,24 @@ After the dry-run, check the output from `nel` for any problems with the config.
256256

257257
**Monitoring Progress**
258258

259-
After job submission, you can monitor progress using:
259+
After job submission, register the job per the **monitor skill** for durable cross-session tracking. For one-off queries (live status, debugging a failed run, analyzing results) use the **launching-evals skill**; for querying past runs in MLflow use **accessing-mlflow**.
260260

261-
1. **Check job status:**
261+
**NEL-specific diagnostics** (for debugging failures):
262262

263-
```bash
264-
nel status <invocation_id>
265-
nel info <invocation_id>
266-
```
267-
268-
2. **Stream logs** (Local execution only):
269-
270-
```bash
271-
nel logs <invocation_id>
272-
```
273-
274-
Note: `nel logs` is not supported for SLURM execution.
275-
276-
3. **Inspect logs via SSH** (SLURM workaround):
277-
278-
When `nel logs` is unavailable (SLURM), use SSH to inspect logs directly:
279-
280-
First, get log locations:
281-
282-
```bash
283-
nel info <invocation_id> --logs
284-
```
285-
286-
Then, use SSH to view logs:
287-
288-
**Check server deployment logs:**
289-
290-
```bash
291-
ssh <username>@<hostname> "tail -100 <log path from `nel info <invocation_id> --logs`>/server-<slurm_job_id>-*.log"
292-
```
293-
294-
Shows vLLM server startup, model loading, and deployment errors (e.g., missing wget/curl).
295-
296-
**Check evaluation client logs:**
297-
298-
```bash
299-
ssh <username>@<hostname> "tail -100 <log path from `nel info <invocation_id> --logs`>/client-<slurm_job_id>.log"
300-
```
301-
302-
Shows evaluation progress, task execution, and results.
303-
304-
**Check SLURM scheduler logs:**
305-
306-
```bash
307-
ssh <username>@<hostname> "tail -100 <log path from `nel info <invocation_id> --logs`>/slurm-<slurm_job_id>.log"
308-
```
309-
310-
Shows job scheduling, health checks, and overall execution flow.
311-
312-
**Search for errors:**
313-
314-
```bash
315-
ssh <username>@<hostname> "grep -i 'error\|warning\|failed' <log path from `nel info <invocation_id> --logs`>/*.log"
316-
```
263+
```bash
264+
# Quick status check
265+
nel status <invocation_id>
266+
nel info <invocation_id>
267+
268+
# Get log paths
269+
nel info <invocation_id> --logs
270+
271+
# Inspect logs via SSH
272+
ssh <user>@<host> "tail -100 <log_path>/server-<slurm_job_id>-*.log" # deployment errors
273+
ssh <user>@<host> "tail -100 <log_path>/client-<slurm_job_id>.log" # evaluation errors
274+
ssh <user>@<host> "tail -100 <log_path>/slurm-<slurm_job_id>.log" # scheduling/walltime
275+
ssh <user>@<host> "grep -i 'error\|failed' <log_path>/*.log" # search all logs
276+
```
317277

318278
---
319279

.claude/skills/monitor/SKILL.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
name: monitor
3+
description: Monitor submitted jobs (PTQ, evaluation, deployment) on SLURM clusters. Use when the user asks "check job status", "is my job done", "monitor my evaluation", "what's the status of the PTQ", "check on job <slurm_job_id>", or after any skill submits a long-running job. Also triggers on "nel status", "squeue", or any request to check progress of a previously submitted job.
4+
---
5+
6+
# Job Monitor
7+
8+
Monitor jobs submitted to SLURM clusters — PTQ quantization, NEL evaluation, model deployment, or raw SLURM jobs.
9+
10+
## When to use
11+
12+
1. **Auto-monitor** — another skill (PTQ, evaluation, deployment) just submitted a job. Register the job and set up monitoring immediately.
13+
2. **User-initiated** — user asks about a job status, possibly in a new conversation. Check the registry, identify the job, and report.
14+
15+
---
16+
17+
## Job Registry
18+
19+
All active jobs are tracked in `.claude/active_jobs.json`. This file is the single source of truth for what's being monitored.
20+
21+
```json
22+
[
23+
{
24+
"type": "nel",
25+
"id": "<invocation_id or slurm_job_id>",
26+
"host": "<cluster_hostname>",
27+
"user": "<ssh_user>",
28+
"submitted": "YYYY-MM-DD HH:MM",
29+
"description": "<what this job does>",
30+
"last_status": "<last known status>"
31+
}
32+
]
33+
```
34+
35+
`type` is one of: `nel`, `slurm`, `launcher`.
36+
37+
---
38+
39+
## On Job Submission
40+
41+
Every time a job is submitted (by any skill or manually):
42+
43+
1. **Add an entry** to `.claude/active_jobs.json`. Create the file if it doesn't exist.
44+
2. **Set up a durable recurring cron** (if one isn't already running) that polls all registered jobs every 15 minutes. The cron prompt should: read the registry, check each job, report state changes to the user, remove completed jobs, and delete itself when the registry is empty.
45+
46+
Always do both steps. Don't try to predict job duration.
47+
48+
---
49+
50+
## On Cron Fire / Status Check
51+
52+
Whether triggered by the cron or by the user asking "check status":
53+
54+
1. **Read the registry** from `.claude/active_jobs.json`
55+
2. **Check each job** using the appropriate method (see below)
56+
3. **Report only state changes** — compare against `last_status` in registry
57+
4. **Update `last_status`** in the registry
58+
5. **Remove completed jobs** — any job in a terminal state (COMPLETED, FAILED, CANCELLED, KILLED)
59+
6. **If registry is empty** — delete the recurring cron
60+
61+
---
62+
63+
## How to Check Each Job Type
64+
65+
### NEL jobs (`type: nel`)
66+
67+
- **Check:** `nel status <id>`
68+
- **On completion:** `nel info <id>` to fetch results
69+
- **On failure:** `nel info <id> --logs` then inspect server/client/SLURM logs via SSH
70+
71+
### Launcher jobs (`type: launcher`)
72+
73+
- **Check:** Tail the launcher's background output file for key events
74+
- **Key events:** experiment ID, SLURM job ID, container import, calibration progress, export path, final status
75+
- **On failure:** Look for `Traceback`, `Error`, or `FAILED` in the output
76+
77+
### Raw SLURM jobs (`type: slurm`)
78+
79+
- **Check:** `ssh <host> "squeue -j <id> -h -o '%T %M %R'"` — if empty, job left the queue
80+
- **On completion:** `ssh <host> "sacct -j <id> --format=State,ExitCode,Elapsed -n"`
81+
- **On failure:** Check the job's output log file
82+
83+
---
84+
85+
## Identifying Jobs (user-initiated, no ID given)
86+
87+
When the user asks about a job without specifying an ID, check in order:
88+
89+
1. `.claude/active_jobs.json` — most reliable, has context
90+
2. `nel ls runs --since 1d` — recent NEL runs
91+
3. `ssh <host> "squeue -u <user>"` — active SLURM jobs
92+
4. `ls -lt tools/launcher/experiments/cicd/ | head -10` — recent launcher experiments
93+
94+
---
95+
96+
## Reporting Guidelines
97+
98+
- **Report state changes proactively** — PENDING → RUNNING, or job completes
99+
- **Aggregate multiple jobs** — "2 of 4 completed (MMLU-Pro: 42.3%, GSM8K: 67.1%), 1 running, 1 pending"
100+
- **Summarize, don't echo** — interpret events ("Calibration complete, exporting checkpoint") not raw logs
101+
- **On failure, diagnose immediately** — check logs and report root cause without waiting for user to ask
102+
- **Minimize noise** — don't report "still running" unless the user is actively asking

.claude/skills/ptq/SKILL.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,7 @@ For SLURM, see `skills/common/slurm-setup.md` and `references/slurm-setup-ptq.md
118118

119119
### Monitoring
120120

121-
- **Launcher**: blocks and tails logs automatically
122-
- **SLURM (manual)**: poll with `squeue -u $USER` + `sleep` (not cron or background tasks)
123-
- **Local**: watch stdout
121+
After job submission, register the job and set up monitoring per the **monitor skill**.
124122

125123
## Step 5 — Verify output
126124

0 commit comments

Comments
 (0)