Skip to content
Open
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
50 changes: 44 additions & 6 deletions docs/cli/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2019,15 +2019,16 @@ nemo inference deployments create [OPTIONS] [NAME]
* `--input-file`: Path to JSON file (use '-' for stdin)
* `--input-data`: Input data for the request (JSON or YAML)

**Output Options:**
**Lifecycle Options:**

* `--output-format, -f <CHOICE>`: Output format for an entity. [possible values: json, yaml, raw, code]
* `--wait`: Wait for the created deployment to be up and running
* `--watch`: Watch the created deployment until it is stable, streaming status updates
* `--timeout <INTEGER RANGE>`: Maximum time to wait or watch in seconds [default: 1200]
* `--poll-interval <INTEGER RANGE>`: Seconds between status checks [default: 3]

**Wait Options:**
**Output Options:**

* `--wait`: Wait for the created deployment to reach a terminal state
* `--timeout <INTEGER RANGE>`: Maximum time to wait in seconds [default: 1200]
* `--poll-interval <INTEGER RANGE>`: Seconds between status checks [default: 3]
* `--output-format, -f <CHOICE>`: Output format for an entity. [possible values: json, yaml, raw, code]

##### nemo inference deployments delete

Expand Down Expand Up @@ -3814,6 +3815,7 @@ nemo jobs [OPTIONS] COMMAND [ARGS]...
* `resume`: Resume a paused platform job.
* `get`: Get a platform job by name.
* `update-status-details`: Update the status details of a platform job.
* `watch`: Watch a platform job until it reaches a terminal status.
* `results`: Manage results
* `steps`: Manage steps
* `tasks`: Manage tasks
Expand Down Expand Up @@ -3890,6 +3892,13 @@ nemo jobs create [OPTIONS] [NAME]
* `--input-file`: Path to JSON file (use '-' for stdin)
* `--input-data`: Input data for the request (JSON or YAML)

**Lifecycle Options:**

* `--wait`: Wait for the created job to reach a terminal state without streaming logs
* `--watch`: Watch the created job to a terminal state
* `--timeout <INTEGER RANGE>`: Maximum time to wait or watch in seconds
* `--poll-interval <INTEGER RANGE>`: Seconds between status checks [default: 3]

**Output Options:**

* `--output-format, -f <CHOICE>`: Output format for an entity. [possible values: json, yaml, raw, code]
Expand Down Expand Up @@ -4159,6 +4168,35 @@ nemo jobs update-status-details [OPTIONS] NAME

* `--output-format, -f <CHOICE>`: Output format for an entity. [possible values: json, yaml, raw, code]

#### nemo jobs watch

Watch a platform job until it reaches a terminal status.

**Usage:**

```shell
nemo jobs watch [OPTIONS] NAME
```

**Arguments:**

* `<NAME>`: Name of the platform job to watch

**Options:**

* `--workspace`: Workspace containing the job
* `--attempt-id <INTEGER>`: Filter logs to an attempt ID
* `--step-id`: Filter logs to a step ID
* `--task-id`: Filter logs to a task ID
* `--limit <INTEGER RANGE>`: Maximum logs to fetch per page
* `--timeout <INTEGER RANGE>`: Maximum watch time in seconds
* `--poll-interval <INTEGER RANGE>`: Seconds between status checks [default: 3]
* `--history, --no-history`: Include logs already present before watching

**Help:**

* `--help, -h`: Show this message and exit.

#### nemo jobs results

Manage results
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading