Multi-Machine Training

delete

Delete a multi-machine job.

list

List multi-machine jobs for a given teamspace.

run

Run async workloads on multiple machines using a docker image.

stop

Stop a multi-machine job.

NAME

text

yes

Multi-machine training run name to delete.

--teamspace

TEXT

no

Sentinel.UNSET

Override default teamspace (format: owner/teamspace).

--name

TEXT

no

—

The multi-machine job name. Required.

--json

—

no

—

Output as JSON (inspect always emits JSON).

--teamspace

TEXT

no

—

the teamspace to list multi-machine jobs from. Should be specified as {owner}/{name}. Defaults to the configured teamspace.

--sort-by, --sort_by

[name|teamspace|studio|image|status|machine|cloud-account]

no

—

the attribute to sort the multi-machine jobs by.

download

Download the complete logs for a multi-machine job.

--teamspace

TEXT

no

—

Teamspace owner/name. Uses the configured default teamspace when omitted.

--tail

INTEGER

no

—

Only show the last N lines.

--since

TEXT

no

—

Only include lines at or after this time (e.g. “2h”, RFC3339).

--query

TEXT

no

—

Only include lines containing every whitespace-separated term.

--json

—

no

—

Output entries as a JSON array.

NAME

text

no

The multi-machine job name. Required.

--teamspace

TEXT

no

—

Teamspace owner/name. Uses the configured default teamspace when omitted.

--name

TEXT

no

—

The name of the job. Needs to be unique within the teamspace.

--machine

[CPU_SMALL|CPU|CPU_X_2|CPU_X_4|CPU_X_8|CPU_X_16|DATA_PREP|DATA_PREP_MAX|DATA_PREP_ULTRA|T4_SMALL|T4|T4_X_2|T4_X_4|T4_X_8|L4|L4_X_2|L4_X_4|L4_X_8|L40S|L40S_X_2|L40S_X_4|L40S_X_8|RTXP_6000|RTXP_6000_X_2|RTXP_6000_X_4|RTXP_6000_X_8|A100|A100_X_2|A100_X_4|A100_X_8|H100|H100_X_2|H100_X_4|H100_X_8|H200|H200_X_2|H200_X_4|H200_X_8|B200|B200_X_8]

no

'CPU'

The machine type to run the job on.

--studio

TEXT

no

—

The studio env to run the multi-machine job with. Mutually exclusive with image. If both –studio and –image are omitted while running inside a Studio, defaults to that Studio (if its teamspace matches –teamspace).

--teamspace

TEXT

no

—

The teamspace to use, as a bare name or an ‘owner/teamspace’ slug. Defaults to the current teamspace.

--user

TEXT

no

—

The user owning the teamspace (if any). Defaults to the current user.(DEPRECATED: Pass the owner as part of –teamspace instead, e.g. ‘–teamspace owner/teamspace’. This option will be removed in a future release.)

--env, -e

TEXT

no

['']

Environment variable to set inside the job. Should be of format KEY=VALUE

--image-credentials, --image_credentials

TEXT

no

—

The credentials used to pull the image. Required if the image is private. This should be the name of the respective credentials secret created on the Lightning AI platform.

--entrypoint

TEXT

no

—

The entrypoint of your docker container. Default runs the provided command in a standard shell. To use the pre-defined entrypoint of the provided image, set this to an empty string. Only applicable when submitting docker jobs.

--path-mappings, --path_mappings

TEXT

no

''

Maps path inside of containers to paths inside data-connections. Should be a comma separated list of form: <MAPPING_1>,<MAPPING_2>,… where each mapping is of the form <CONTAINER_PATH_1>:<CONNECTION_NAME_1>:<PATH_WITHIN_CONNECTION_1> and omitting the path inside the connection defaults to the connections root. Instead of a comma-separated list, consider passing –path-mapping multiple times.

--json

—

no

—

Output the created job as JSON.

NAME

text

yes

No description provided.

--teamspace

TEXT

no

—

the name of the teamspace the multi-machine job lives in. Should be specified as {teamspace_owner}/{teamspace_name} (e.g my-org/my-teamspace). If not specified, uses the configured default teamspace.

NAME

text

yes

Multi-machine training run name to stop.

--teamspace

TEXT

no

—

the name of the teamspace the multi-machine job lives in. Should be specified as {teamspace_owner}/{teamspace_name} (e.g my-org/my-teamspace). If not specified, uses the configured default teamspace.