15.3. Getting Started

Thie document describes clara commands.

15.3.1. create model

Create a model from a directory. The Model Directory must conform to TRITON server specifications.

15.3.1.1. Usage

$ clara create model -p [MODEL_DIRECTORY] -t [MODEL_TYPE] [--raw]

15.3.1.2. Flags

Name

Shorthand

Default

Usage

path

p

Model path

type

t

Model Type {“tensorflow”, “tensorrt”, “pytorch”, “unknown”}

raw

r

false

Show output in raw format

15.3.2. list model

Lists information about models

15.3.2.1. Usage

$ clara list models [--quiet]

15.3.2.2. Flags

Name

Shorthand

Default

Usage

quiet

q

false

Only show model ids

15.3.3. delete models

Delete models.

15.3.3.1. Usage

$ clara delete models [MODEL_ID]...

15.3.3.2. Arguments

Name

Default

Usage

MODEL_ID

The full or partial unique identifier of the model. Partial unique identifiers can be used so long as it matches from left-to-right and uniquely identifies a model.

All the model ids passed as argument are deleted.

15.3.4. create job

Creates a job from a name, pipeline id, job priority and file or directory.

15.3.4.1. Usage

$ clara create job -n NAME -p PIPELINE_ID [-f [FILE | DIRECTORY]] [-i JOB_PRIORITY]

15.3.4.2. Flags

Name

Shorthand

Default

Usage

name

n

Name of the job

pipeline

p

Pipeline id

priority

i

normal

Job Priority {“low”, “normal”, “high”, “immediate}”

files

f

Filename or directory to files used to create the job

raw

r

false

Show output in raw format

15.3.5. start job

Starts a created job from job id.

15.3.5.1. Usage

$ clara start job -j JOB_ID [-a KEY=VALUE]...

15.3.5.2. Flags

Name

Shorthand

Default

Usage

args

a

Argument to the job in KEY=VALUE format

job

j

Job id

15.3.6. create pipelines

Creates a clara pipeline.

15.3.6.1. Usage

$ clara create pipeline -p PIPELINE_DEFINITION_FILE

15.3.6.2. Flags

Name

Shorthand

Default

Usage

path

p

Pipeline definition file path

raw

r

false

Show output in raw format

15.3.7. list pipelines

Lists pipelines.

15.3.7.1. Usage

$ clara list pipelines

15.3.7.2. Flags

Name

Shorthand

Default

Usage

quiet

q

false

Only show pipeline ids

15.3.8. describe pipeline

Prints definition of the pipeline.

15.3.8.1. Usage

$ clara describe pipeline -p PIPELINE_ID

15.3.8.2. Flags

Name

Shorthand

Default

Usage

pipeline

p

The full or partial unique identifier of the Clara pipeline. Partial unique identifiers can be used so long as it matches from left-to-right and uniquely identifies a pipeline.

15.3.9. list jobs

Lists jobs.

15.3.9.1. Usage

$ clara list jobs

15.3.9.2. Flags

Name

Shorthand

Default

Usage

quiet

q

false

Only show job ids

all

false

List all jobs including canceled ones

15.3.10. cancel jobs

Submit reuqest to cancel job(s).

15.3.10.1. Usage

$ clara cancel jobs [-j JOB_ID1,JOB_ID2...] [--all]
$ clara cancel jobs [-j JOB_ID1,JOB_ID2...] [--all]

15.3.10.2. Flags

Name

Shorthand

Default

Usage

all

false

Cancel all jobs

15.3.10.3. Arguments

Name

Default

Usage

JOB_ID

The full or partial unique identifier of the Clara job. Partial unique identifiers can be used so long as it matches from left-to-right and uniquely identifies a job.

15.3.11. delete payloads

Delete payloads.

15.3.11.1. Usage

$ clara delete payloads -p PAYLOAD_ID1[,PAYLOAD_ID2...]
$ clara delete payload -p PAYLOAD_ID1[,PAYLOAD_ID2...]

15.3.11.2. Arguments

Name

Default

Usage

PAYLOAD_ID

Full unique identifier of the clara payload.

15.3.12. download

Download files associated with the selected job.

15.3.12.1. Usage

$ clara download JOB_ID:SRC_PATH [DEST_PATH] [flags]

15.3.12.2. Arguments

Name

Default

Usage

JOB_ID

The full or partial unique identifier of the Clara job from which to download content from. Partial unique identifiers can be used so long as it matches from left-to-right and uniquely identifies a job.

SRC_PATH

Source path of the file(s) to download. File names are relative to the root of the payload. Supports simple glob style pattern matching.

DEST_PATH

.

Optional destination path where the files will be downloaded. By default file(s) will be downloaded to the current directory.

15.3.13. describe job

Prints the information and status of the job.

15.3.13.1. Usage

$ clara describe job -j JOB_ID

15.3.13.2. Flags

Name

Shorthand

Default

Usage

job

j

The full or partial unique identifier of the Clara job from which to download content from. Partial unique identifiers can be used so long as it matches from left-to-right and uniquely identifies a job.

15.3.14. config

Configures NGC credentials for use by CLI.

15.3.14.1. Usage

$ clara config [flags]

15.3.14.2. Flags

Name

Shorthand

Default

Usage

key

NGC API Key

orgteam

Org and team (input format: “{org}[/{team}]” team is optional)

yes

y

false

Bypass the prompt

15.3.15. logs (deprecated)

Prints logs from clara containers.

15.3.15.1. Usage

$ clara logs [flags]

15.3.15.2. Available Containers

CONTAINER_NAME

DESCRIPTION

apiserver

clara platform api server

controller

clara workflow controller

elastic

clara elasticsearch

fluentd

clara fluentd

grafana

clara grafana

ui

clara ui

15.3.15.3. Flags

Name

Shorthand

Default

Usage

container

c

Clara container name

job

j

Clara Job Id

operator

o

Clara Job Operator

perf

false

Include performance logs as well

top

t

100

Maximum number of log entries to print

15.3.16. version

Displays the clara cli and clara platform version info

15.3.16.1. Usage

$ clara version