Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 20 additions & 5 deletions docs/customizer/manage-customization-jobs/get-job-status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Get detailed execution status for a customization job, including step-by-step pr

This endpoint provides granular execution details including:

- **Step-level status**: `model-and-dataset-download` → `customization-training-job` → `model-upload` → `model-entity-creation`
- **Step-level status**: `model-and-dataset-download` → `training` → `model-upload` → `model-entity-creation`
- **Training metrics**: `step`, `epoch`, `loss`, `lr` (learning rate), `grad_norm`, `val_loss`
- **Progress tracking**: `downloaded_files`, `uploaded_bytes`, `progress_pct`

Expand Down Expand Up @@ -45,7 +45,7 @@ client = NeMoPlatform(
workspace="default",
)

# Get job status (use the job name returned by jobs.create)
# Get job status (use the job name returned at submission)
job_name = "automodel-a1b2c3d4e5f6"
status = client.jobs.get_status(name=job_name, workspace="default")

Expand All @@ -55,7 +55,7 @@ print(f"Status: {status.status}")
# Check step-level status and training progress
for step in status.steps or []:
print(f" Step '{step.name}': {step.status}")
if step.name == "customization-training-job":
if step.name == "training":
for task in step.tasks or []:
task_details = task.status_details or {}
current_step = task_details.get("step")
Expand All @@ -64,6 +64,21 @@ for step in status.steps or []:
print(f" Progress: {current_step}/{max_steps}")
```

### CLI

```bash
nemo jobs get-status automodel-a1b2c3d4e5f6 --workspace default
```

### REST API

```bash
curl -X GET \
"${NMP_BASE_URL}/apis/jobs/v2/workspaces/default/jobs/automodel-a1b2c3d4e5f6/status" \
-H 'Accept: application/json' \
| jq
```

<Accordion title="Example Response">

**Active Job (Training in Progress)**
Expand Down Expand Up @@ -111,7 +126,7 @@ for step in status.steps or []:
{
"id": "platform-job-step-9kme8ibxDGES4t9TZvLp4X",
"error_details": {},
"name": "customization-training-job",
"name": "training",
"status": "active",
"status_details": {
"message": "Job is running"
Expand Down Expand Up @@ -187,7 +202,7 @@ for step in status.steps or []:
{
"id": "platform-job-step-9kme8ibxDGES4t9TZvLp4X",
"error_details": {},
"name": "customization-training-job",
"name": "training",
"status": "completed",
"status_details": {
"message": "Job completed successfully with exit code 0"
Expand Down
Loading
Loading