From 539cfbc3df48143f65feb3376069bd17f1cb1754 Mon Sep 17 00:00:00 2001 From: Sierra Guequierre Date: Fri, 30 Aug 2024 16:36:24 -0400 Subject: [PATCH] DOCS-2871: Add `logs` command to `train` in CLI (#3372) --- docs/cli.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/cli.md b/docs/cli.md index c5deef0ed4..c4d2f3ba5d 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -1309,6 +1309,7 @@ viam train submit managed --dataset-id= --model-org-id= --org-id= --model-name= --script-name= --version= [...named args] viam train submit custom with-upload --dataset-id= --org-id= --model-name= --path= --script-name= [...named args] viam train get --job-id= +viam train logs --job-id= viam train cancel --job-id= viam train list --org-id= --job-status= ``` @@ -1328,6 +1329,9 @@ viam train submit custom with-upload --dataset-id= --model-or # get a training job from Viam cloud based on training job ID viam train get --job-id=123 +# get training job logs from Viam cloud based on training job ID +viam train logs --job-id=123 + # cancel training job in Viam cloud based on training job ID viam train cancel --job-id=123 @@ -1342,6 +1346,7 @@ viam train list --org-id=123 --job-status=completed | -------------- | ----------- | -------------------- | | `submit` | Submits training job on data in the Viam cloud. | `managed`, `custom` | | `get` | Gets a training job from the Viam cloud based on training job ID. | - | +| `logs` | Gets the logs of a training job from the Viam cloud based on training job ID. | - | | `cancel` | Cancels training job in the Viam cloud based on training job ID. | - | | `list` | Lists training jobs in Viam cloud based on organization ID and job status. | - | @@ -1376,7 +1381,7 @@ viam train list --org-id=123 --job-status=completed | `--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** | | `--version` | The version of the ML training script to use for training. | `submit custom from-registry`, `submit custom with-upload` | **Required** | | `--path` | The path to the ML training script to upload. | `submit custom with-upload` | **Required** | -| `--job-id` | The ID of the training job to get or cancel. You can retrieve this value with `train list`. | `get`, `cancel` | **Required** | +| `--job-id` | The ID of the training job to get or cancel. You can retrieve this value with `train list`. | `get`, `logs`, `cancel` | **Required** | | `--job-status` | Training status to filter for. Can be one of `canceled`, `canceling`, `completed`, `failed`, `in_progress`, `pending`, or `unspecified`. | `list` | **Required** | | `--framework` | Framework of the ML training script to upload, can be `tflite`, `tensorflow`, `pytorch`, or `onnx`. | `submit custom with-upload` | Optional |