Skip to content

Commit 539cfbc

Browse files
authoredAug 30, 2024··
DOCS-2871: Add logs command to train in CLI (#3372)
1 parent 356041d commit 539cfbc

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed
 

‎docs/cli.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1309,6 +1309,7 @@ viam train submit managed --dataset-id=<dataset-id> --model-org-id=<model-org-id
13091309
viam train submit custom from-registry --dataset-id=<dataset-id> --org-id=<org-id> --model-name=<model-name> --script-name=<script-name> --version=<version> [...named args]
13101310
viam train submit custom with-upload --dataset-id=<dataset-id> --org-id=<org-id> --model-name=<model-name> --path=<path> --script-name=<script-name> [...named args]
13111311
viam train get --job-id=<job-id>
1312+
viam train logs --job-id=<job-id>
13121313
viam train cancel --job-id=<job-id>
13131314
viam train list --org-id=<org-id> --job-status=<job-status>
13141315
```
@@ -1328,6 +1329,9 @@ viam train submit custom with-upload --dataset-id=<INSERT DATASET ID> --model-or
13281329
# get a training job from Viam cloud based on training job ID
13291330
viam train get --job-id=123
13301331

1332+
# get training job logs from Viam cloud based on training job ID
1333+
viam train logs --job-id=123
1334+
13311335
# cancel training job in Viam cloud based on training job ID
13321336
viam train cancel --job-id=123
13331337

@@ -1342,6 +1346,7 @@ viam train list --org-id=123 --job-status=completed
13421346
| -------------- | ----------- | -------------------- |
13431347
| `submit` | Submits training job on data in the Viam cloud. | `managed`, `custom` |
13441348
| `get` | Gets a training job from the Viam cloud based on training job ID. | - |
1349+
| `logs` | Gets the logs of a training job from the Viam cloud based on training job ID. | - |
13451350
| `cancel` | Cancels training job in the Viam cloud based on training job ID. | - |
13461351
| `list` | Lists training jobs in Viam cloud based on organization ID and job status. | - |
13471352

@@ -1376,7 +1381,7 @@ viam train list --org-id=123 --job-status=completed
13761381
| `--script-name` | The registry name of the ML training script to use for training. If uploading, this sets the name. | `submit custom from-registry`, `submit custom with-upload` | **Required** |
13771382
| `--version` | The version of the ML training script to use for training. | `submit custom from-registry`, `submit custom with-upload` | **Required** |
13781383
| `--path` | The path to the ML training script to upload. | `submit custom with-upload` | **Required** |
1379-
| `--job-id` | The ID of the training job to get or cancel. You can retrieve this value with `train list`. | `get`, `cancel` | **Required** |
1384+
| `--job-id` | The ID of the training job to get or cancel. You can retrieve this value with `train list`. | `get`, `logs`, `cancel` | **Required** |
13801385
| `--job-status` | Training status to filter for. Can be one of `canceled`, `canceling`, `completed`, `failed`, `in_progress`, `pending`, or `unspecified`. | `list` | **Required** |
13811386
| `--framework` | Framework of the ML training script to upload, can be `tflite`, `tensorflow`, `pytorch`, or `onnx`. | `submit custom with-upload` | Optional |
13821387

0 commit comments

Comments
 (0)
Please sign in to comment.