gradient.cli package¶
-Submodules¶
-gradient.cli.cli module¶
-gradient¶
gradient [OPTIONS] COMMAND [ARGS]...
apiKey¶
Save your api key
gradient apiKey [OPTIONS] [API_KEY]
@@ -95,19 +96,19 @@ apiKeyArguments
-
clusters¶
Manage clusters
gradient clusters [OPTIONS] COMMAND [ARGS]...
list¶
List your team clusters
gradient clusters list [OPTIONS]
@@ -115,42 +116,42 @@ listOptions
-
machineTypes¶
Manage machine types
gradient clusters machineTypes [OPTIONS] COMMAND [ARGS]...
list¶
List available machine types
gradient clusters machineTypes list [OPTIONS]
@@ -158,39 +159,39 @@ list
Options
-
datasets¶
Manage datasets
gradient datasets [OPTIONS] COMMAND [ARGS]...
create¶
Create dataset
gradient datasets create [OPTIONS]
@@ -198,43 +199,43 @@ createOptions
--
-
--storageProviderId
<storage_provider_id>
¶
+-
+--storageProviderId <storage_provider_id>¶
Required Storage provider ID
-
delete¶
Delete dataset
gradient datasets delete [OPTIONS]
@@ -242,31 +243,31 @@ deleteOptions
-
details¶
Show dataset details
gradient datasets details [OPTIONS]
@@ -274,37 +275,37 @@ detailsOptions
-
files¶
Manage files
gradient datasets files [OPTIONS] COMMAND [ARGS]...
delete¶
Delete files
gradient datasets files delete [OPTIONS]
@@ -312,37 +313,37 @@ deleteOptions
--
-
--id
<dataset_version_id>
¶
+-
+--id <dataset_version_id>¶
Required Dataset version ID (ex: dsr8k5qzn401lb5:klfoyy9)
-
get¶
Get files
gradient datasets files get [OPTIONS]
@@ -350,43 +351,43 @@ getOptions
--
-
--id
<dataset_version_id>
¶
+-
+--id <dataset_version_id>¶
Required Dataset version ID (ex: dsr8k5qzn401lb5:klfoyy9)
-
list¶
List files
gradient datasets files list [OPTIONS]
@@ -394,43 +395,43 @@ listOptions
--
-
--id
<dataset_version_id>
¶
+-
+--id <dataset_version_id>¶
Required Dataset version ID (ex: dsr8k5qzn401lb5:klfoyy9)
-
put¶
Put files
gradient datasets files put [OPTIONS]
@@ -438,118 +439,44 @@ putOptions
--
-
--id
<dataset_version_id>
¶
+-
+--id <dataset_version_id>¶
Required Dataset version ID (ex: dsr8k5qzn401lb5:klfoyy9)
--
-
--apiKey
<api_key>
¶
-API key to use this time only
-
-
-
--
-
--optionsFile
<options_file>
¶
-Path to YAML file with predefined options
-
-
-
--
-
--createOptionsFile
<createoptionsfile>
¶
-Generate template options file
-
-
-
import¶
-Import dataset
-gradient datasets import [OPTIONS]
-
Options
--
-
-
-
--clusterId
<cluster_id>
¶
- Required Cluster ID
-
-
-
-
-
--machineType
<machine_type>
¶
- Required Virtual machine type
-
-
-
-
-
--datasetId
<dataset_id>
¶
- Required Dataset ID
-
-
-
-
-
--s3Url
<s3_url>
¶
- - -
-
-
-
-
--httpUrl
<http_url>
¶
- HTTP/S URL https://data.something.org/all_my_data.zip}}
-
-
-
-
-
--httpAuth
<http_auth>
¶
- Http Auth username:password
-
-
-
-
-
--s3AccessKey
<access_key>
¶
- S3 access key
-
-
-
-
-
--s3SecretKey
<secret_key>
¶
- S3 secret key
-
list¶
List datasets
gradient datasets list [OPTIONS]
@@ -557,31 +484,31 @@ listOptions
-
tags¶
Manage tags
gradient datasets tags [OPTIONS] COMMAND [ARGS]...
delete¶
Delete dataset tag
gradient datasets tags delete [OPTIONS]
@@ -589,31 +516,31 @@ deleteOptions
-
list¶
List dataset tags
gradient datasets tags list [OPTIONS]
@@ -621,31 +548,31 @@ listOptions
-
set¶
Set dataset tag
update¶
Update dataset
gradient datasets update [OPTIONS]
@@ -692,49 +619,49 @@ updateOptions
-
versions¶
Manage versions
gradient datasets versions [OPTIONS] COMMAND [ARGS]...
commit¶
Commit dataset version
gradient datasets versions commit [OPTIONS]
@@ -742,31 +669,31 @@ commit
Options
--
-
--id
<dataset_version_id>
¶
+-
+--id <dataset_version_id>¶
Required Dataset version ID (ex: dsr8k5qzn401lb5:klfoyy9)
-
create¶
Create dataset version
gradient datasets versions create [OPTIONS]
@@ -774,43 +701,43 @@ create
Options
--
-
--id
<dataset_id>
¶
+-
+--id <dataset_id>¶
Required Dataset version ID (ex: dsr8k5qzn401lb5:klfoyy9)
--
-
--source-path
<source_paths>
¶
+-
+--source-path <source_paths>¶
Files to put into dataset version (setting this will commit the version)
-
delete¶
Delete dataset version
gradient datasets versions delete [OPTIONS]
@@ -818,1093 +745,296 @@ delete
Options
--
-
--id
<dataset_version_id>
¶
+-
+--id <dataset_version_id>¶
Required Dataset version ID (ex: dsr8k5qzn401lb5:klfoyy9)
-
details¶
Show dataset version details
gradient datasets versions details [OPTIONS]
Options
--
-
-
-
--id
<dataset_version_id>
¶
- Required Dataset version ID (ex: dsr8k5qzn401lb5:klfoyy9)
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
list¶
-List dataset versions
-gradient datasets versions list [OPTIONS]
-
Options
--
-
-
-
--id
<dataset_id>
¶
- Required Dataset ID (ex: dsr8k5qzn401lb5)
-
-
-
-
-
--isCommitted
<is_committed>
¶
- Show filter by committed status
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
update¶
-Update dataset version
-gradient datasets versions update [OPTIONS]
-
Options
--
-
-
-
--id
<dataset_version_id>
¶
- Required Dataset version ID (ex: dsr8k5qzn401lb5:klfoyy9)
-
-
-
-
-
--message
<message>
¶
- Dataset version message
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
deployments¶
-Manage deployments
-gradient deployments [OPTIONS] COMMAND [ARGS]...
-
create¶
-Create new deployment
-gradient deployments create [OPTIONS]
-
Options
--
-
-
-
--deploymentType
<deployment_type>
¶
- Required Model deployment type
--
-
- Options -
TFServing | ONNX | Custom | Flask | TensorRT
-
-
-
-
-
-
--projectId
<project_id>
¶
- Project ID
-
-
-
-
-
--modelId
<model_id>
¶
- ID of a trained model
-
-
-
-
-
--name
<name>
¶
- Required Human-friendly name for new model deployment
-
-
-
-
-
--machineType
<machine_type>
¶
- Required Type of machine for new deployment
-
-
-
-
-
--imageUrl
<image_url>
¶
- Required Docker image for model serving
-
-
-
-
-
--instanceCount
<instance_count>
¶
- Number of machine instances
-
-
-
-
-
--command
<command>
¶
- Deployment command
-
-
-
-
-
--containerModelPath
<container_model_path>
¶
- Container model path
-
-
-
-
-
--imageUsername
<image_username>
¶
- Username used to access docker image
-
-
-
-
-
--imagePassword
<image_password>
¶
- Password used to access docker image
-
-
-
-
-
--imageServer
<image_server>
¶
- Docker image server
-
-
-
-
-
--containerUrlPath
<container_url_path>
¶
- Container URL path
-
-
-
-
-
--method
<method>
¶
- Method
-
-
-
-
-
--dockerArgs
<docker_args>
¶
- JSON-style list of docker args
-
-
-
-
-
--env
<env>
¶
- JSON-style environmental variables map
-
-
-
-
-
--apiType
<api_type>
¶
- Type of API
-
-
-
-
-
--ports
<ports>
¶
- Ports
-
-
-
-
-
--clusterId
<cluster_id>
¶
- Cluster ID
-
-
-
-
-
--authUsername
<auth_username>
¶
- Username
-
-
-
-
-
--authPassword
<auth_password>
¶
- Password
-
-
-
-
-
--auth
¶
- Generate username and password. Mutually exclusive with –authUsername and –authPassword
-
-
-
-
-
--tag
<tags>
¶
- One or many tags that you want to add to model deployment job
-
-
-
-
-
--tags
<tags_comma>
¶
- Separated by comma tags that you want add to model deployment job
-
-
-
-
-
--workspace
<workspace>
¶
- Path to workspace directory, archive, S3 or git repository
-
-
-
-
-
--workspaceRef
<workspace_ref>
¶
- Git commit hash, branch name or tag
-
-
-
-
-
--workspaceUsername
<workspace_username>
¶
- Workspace username
-
-
-
-
-
--workspacePassword
<workspace_password>
¶
- Workspace password
-
-
-
-
-
--minInstanceCount
<min_instance_count>
¶
- Minimal instance count
-
-
-
-
-
--maxInstanceCount
<max_instance_count>
¶
- Maximal instance count
-
-
-
-
-
--scaleCooldownPeriod
<scale_cooldown_period>
¶
- Scale cooldown period
-
-
-
-
-
--metric
<metrics>
¶
- Autoscaling metrics. Example: my_metric/targetAverage:21.37
-
-
-
-
-
--resource
<resources>
¶
- Autoscaling resources. Example: cpu/target:60
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
delete¶
-Delete deployment
-gradient deployments delete [OPTIONS]
-
Options
--
-
-
-
--id
<id_>
¶
- Required Deployment ID
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
details¶
-Get details of model deployment
-gradient deployments details [OPTIONS]
-
Options
--
-
-
-
--id
<deployment_id>
¶
- Required Deployment ID
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
list¶
-List deployments with optional filtering
-gradient deployments list [OPTIONS]
-
Options
--
-
-
-
--state
<state>
¶
- Filter by deployment state
--
-
- Options -
BUILDING | PROVISIONING | STARTING | RUNNING | STOPPING | STOPPED | ERROR
-
-
-
-
-
-
--projectId
<project_id>
¶
- Use to filter by project ID
-
-
-
-
-
--modelId
<model_id>
¶
- Use to filter by model ID
-
-
-
-
-
--tag
<tags>
¶
- Filter by tags. Multiple use
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
logs¶
-List deployment logs
-gradient deployments logs [OPTIONS]
-
Options
--
-
-
-
--id
<deployment_id>
¶
- Required
-
-
-
-
-
--line
<line>
¶
-
-
-
-
-
--limit
<limit>
¶
-
-
-
-
-
--follow
<follow>
¶
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
metrics¶
-Read model deployment metrics
-gradient deployments metrics [OPTIONS] COMMAND [ARGS]...
-
get¶
-Get model deployment metrics. Shows CPU and RAM usage by default
-gradient deployments metrics get [OPTIONS]
-
Options
--
-
-
-
--id
<deployment_id>
¶
- Required ID of the model deployment
-
-
-
-
-
--metric
<metrics_list>
¶
- One or more metrics that you want to read: cpuPercentage, memoryUsage, gpuMemoryFree, gpuMemoryUsed, gpuPowerDraw, gpuTemp, gpuUtilization, gpuMemoryUtilization. Defaults to cpuPercentage and memoryUsage. To view available custom metrics, use command: gradient deployments metrics list
-
-
-
-
-
--interval
<interval>
¶
- Interval
-
-
-
-
-
--start
<start>
¶
- Timestamp of first time series metric to collect
-
-
-
-
-
--end
<end>
¶
- Timestamp of last time series metric to collect
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
list¶
-List model deployment metrics. Shows CPU and RAM usage by default
-gradient deployments metrics list [OPTIONS]
-
Options
--
-
-
-
--id
<deployment_id>
¶
- Required ID of the model deployment
-
-
-
-
-
--interval
<interval>
¶
- Interval
-
-
-
-
-
--start
<start>
¶
- Timestamp of first time series metric to collect
-
-
-
-
-
--end
<end>
¶
- Timestamp of last time series metric to collect
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
stream¶
-Watch live model deployment metrics. Shows CPU and RAM usage by default
-gradient deployments metrics stream [OPTIONS]
-
Options
--
-
-
-
--id
<deployment_id>
¶
- Required ID of the model deployment
-
-
-
-
-
--metric
<metrics_list>
¶
- One or more metrics that you want to read. Defaults to cpuPercentage and memoryUsage
--
-
- Options -
cpuPercentage | memoryUsage | gpuMemoryFree | gpuMemoryUsed | gpuPowerDraw | gpuTemp | gpuUtilization | gpuMemoryUtilization
-
-
-
-
-
-
--interval
<interval>
¶
- Interval
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
start¶
-Start deployment
-gradient deployments start [OPTIONS]
-
Options
--
-
-
-
--id
<id_>
¶
- Required Deployment ID
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
stop¶
-Stop deployment
-gradient deployments stop [OPTIONS]
-
Options
--
-
-
-
--id
<id_>
¶
- Required Deployment ID
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
tags¶
-Manage deployments tags
-gradient deployments tags [OPTIONS] COMMAND [ARGS]...
-
add¶
-Add tags to deployment
-gradient deployments tags add [OPTIONS]
-
Options
--
-
-
-
--id
<id>
¶
- Required ID of the deployment
-
-
-
-
-
--tag
<tags>
¶
- One or many tags that you want to add to deployment
-
-
-
-
-
--tags
<tags_comma>
¶
- Separated by comma tags that you want add to deployment
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
remove¶
-Remove tags from deployment
-gradient deployments tags remove [OPTIONS]
-
Options
--
-
-
-
--id
<id>
¶
- Required ID of the deployment
-
-
-
-
-
--tag
<tags>
¶
- One or many tags that you want to remove from deployment
-
-
-
-
-
--tags
<tags_comma>
¶
- Separated by comma tags that you want to remove from deployment
-
-
-
-
-
--apiKey
<api_key>
¶
- API key to use this time only
-
-
-
-
-
--optionsFile
<options_file>
¶
- Path to YAML file with predefined options
-
-
-
-
-
--createOptionsFile
<createoptionsfile>
¶
- Generate template options file
-
update¶
-Modify existing deployment
-gradient deployments update [OPTIONS]
-
Options
--
-
-
-
--id
<deployment_id>
¶
- Required ID of existing deployment
-
-
-
-
-
--deploymentType
<deployment_type>
¶
- Model deployment type
--
-
- Options -
TFServing | ONNX | Custom | Flask | TensorRT
-
-
-
-
-
-
--projectId
<project_id>
¶
- Project ID
-
-
-
-
-
--modelId
<model_id>
¶
- ID of a trained model
-
Options
-
-
-
-
--name
<name>
¶
- Human-friendly name for new model deployment
+- +--id <dataset_version_id>¶ +
Required Dataset version ID (ex: dsr8k5qzn401lb5:klfoyy9)
-
-
-
-
--machineType
<machine_type>
¶
- Type of machine for new deployment
+- +--apiKey <api_key>¶ +
API key to use this time only
-
-
-
-
--imageUrl
<image_url>
¶
- Docker image for model serving
+- +--optionsFile <options_file>¶ +
Path to YAML file with predefined options
-
-
-
-
--instanceCount
<instance_count>
¶
- Number of machine instances
+- +--createOptionsFile <createoptionsfile>¶ +
Generate template options file
list¶
+List dataset versions
+gradient datasets versions list [OPTIONS]
+
Options
-
-
-
-
--command
<command>
¶
- Deployment command
+- +--id <dataset_id>¶ +
Required Dataset ID (ex: dsr8k5qzn401lb5)
-
-
-
-
--containerModelPath
<container_model_path>
¶
- Container model path
+- +--isCommitted <is_committed>¶ +
Show filter by committed status
-
-
-
-
--imageUsername
<image_username>
¶
- Username used to access docker image
+- +--apiKey <api_key>¶ +
API key to use this time only
update¶
+Update dataset version
+gradient datasets versions update [OPTIONS]
+
Options
-
-
-
-
--containerUrlPath
<container_url_path>
¶
- Container URL path
+- +--id <dataset_version_id>¶ +
Required Dataset version ID (ex: dsr8k5qzn401lb5:klfoyy9)
-
-
-
-
--dockerArgs
<docker_args>
¶
- JSON-style list of docker args
+- +--apiKey <api_key>¶ +
API key to use this time only
deployments¶
+Manage Deployments
+gradient deployments [OPTIONS] COMMAND [ARGS]...
+
create¶
+Create a deployment
+gradient deployments create [OPTIONS]
+
Options
+delete¶
+Delete a deployment
+gradient deployments delete [OPTIONS]
+
Options
+get¶
+Get a deployment
+gradient deployments get [OPTIONS]
+
Options
+list¶
+List deployments
+gradient deployments list [OPTIONS]
+
Options
+update¶
+Update a deployment
+gradient deployments update [OPTIONS]
+
Options
-
-
-
-
--metric
<metrics>
¶
- Autoscaling metrics. Example: my_metric/targetAverage:21.37
+- +--name <name>¶ +
Name
-
-
-
-
--resource
<resources>
¶
- Autoscaling resources. Example: cpu/target:60
+- +--projectId <project_id>¶ +
Project ID
experiments¶
Manage experiments
gradient experiments [OPTIONS] COMMAND [ARGS]...
create¶
Create new experiment
gradient experiments create [OPTIONS] COMMAND [ARGS]...
multinode¶
Create multi node experiment
gradient experiments create multinode [OPTIONS]
@@ -1912,110 +1042,110 @@ multinode
Options
--
-
--workspace
<workspace>
¶
+-
+--workspace <workspace>¶
Path to workspace directory, archive, S3 or git repository
--
-
--workspaceRef
<workspace_ref>
¶
+-
+--workspaceRef <workspace_ref>¶
Git commit hash, branch name or tag
--
-
--workspacePassword
<workspace_password>
¶
+-
+--workspacePassword <workspace_password>¶
Workspace password
--
-
--ignoreFiles
<ignore_files>
¶
+-
+--ignoreFiles <ignore_files>¶
Ignore certain files from uploading
--
-
--workingDirectory
<working_directory>
¶
+-
+--workingDirectory <working_directory>¶
Working directory for the experiment
--
-
--artifactDirectory
<artifact_directory>
¶
+-
+--artifactDirectory <artifact_directory>¶
Artifacts directory
--
-
--experimentEnv
<experiment_env>
¶
+-
+--experimentEnv <experiment_env>¶
Environment variables in a JSON
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want add to experiment
--
-
--experimentType
<experiment_type_id>
¶
+-
+--experimentType <experiment_type_id>¶
Required Experiment Type
--
-
--workerMachineType
<machine type>
¶
+-
+--workerMachineType <machine type>¶
Required Worker machine type
--
-
--parameterServerContainer
<container>
¶
+-
+--parameterServerContainer <container>¶
Parameter server container (GRPC only)
--
-
--parameterServerMachineType
<machine type>
¶
+-
+--parameterServerMachineType <machine type>¶
Parameter server machine type (GRPC only)
--
-
--parameterServerCommand
<command>
¶
+-
+--parameterServerCommand <command>¶
Parameter server command (GRPC only)
--
-
--parameterServerCount
<parameter_server_count>
¶
+-
+--parameterServerCount <parameter_server_count>¶
Parameter server count (GRPC only)
--
-
--masterMachineType
<machine type>
¶
+-
+--masterMachineType <machine type>¶
Master machine type (MPI only)
--
-
--workerContainerUser
<worker_container_user>
¶
+-
+--workerContainerUser <worker_container_user>¶
Worker container user
--
-
--workerRegistryUsername
<worker_registry_username>
¶
+-
+--workerRegistryUsername <worker_registry_username>¶
Worker container registry username
--
-
--workerRegistryPassword
<password>
¶
+-
+--workerRegistryPassword <password>¶
Worker registry password
--
-
--parameterServerContainerUser
<parameter_server_container_user>
¶
+-
+--parameterServerContainerUser <parameter_server_container_user>¶
Parameter server container user
--
-
--parameterServerRegistryUsername
<parameter_server_registry_username>
¶
+-
+--parameterServerRegistryUsername <parameter_server_registry_username>¶
Parameter server registry username
--
-
--parameterServerRegistryPassword
<password>
¶
+-
+--parameterServerRegistryPassword <password>¶
Parameter server registry password
--
-
--parameterServerRegistryUrl
<registry url>
¶
+-
+--parameterServerRegistryUrl <registry url>¶
Parameter server registry URL
--
-
--masterContainerUser
<master_container_user>
¶
+-
+--masterContainerUser <master_container_user>¶
Master container user (MPI only)
--
-
--masterRegistryUsername
<username>
¶
+-
+--masterRegistryUsername <username>¶
Master registry username (MPI only)
--
-
--masterRegistryPassword
<password>
¶
+-
+--masterRegistryPassword <password>¶
Master registry password (MPI only)
--
-
--masterRegistryUrl
<registry url>
¶
+-
+--masterRegistryUrl <registry url>¶
Master registry URL (MPI only)
--
-
--datasetAwsAccessKeyId
<AWS access key>
¶
+-
+--datasetAwsAccessKeyId <AWS access key>¶
S3 bucket’s Access Key ID
--
-
--datasetAwsSecretAccessKey
<dataset_secret_access_key_list>
¶
+-
+--datasetAwsSecretAccessKey <dataset_secret_access_key_list>¶
S3 bucket’s Secret Access Key
--
-
--datasetAwsEndpoint
<dataset_endpoint_list>
¶
+-
+--datasetAwsEndpoint <dataset_endpoint_list>¶
S3 endpoint URL
--
-
--datasetVolumeKind
<dataset_volume_kind_list>
¶
+-
+--datasetVolumeKind <dataset_volume_kind_list>¶
S3 dataset’s volume kind. If used, –datasetVolumeSize has to be set as well
--
-
--datasetVolumeSize
<dataset_volume_size_list>
¶
+-
+--datasetVolumeSize <dataset_volume_size_list>¶
S3 dataset’s volume size
--
-
--tensorboard_set
<tensorboard ID>
¶
+-
+--tensorboard_set <tensorboard ID>¶
Add to existing tensorboard
-
singlenode¶
Create single node experiment
gradient experiments create singlenode [OPTIONS]
@@ -2272,200 +1402,200 @@ singlenodeOptions
--
-
--workspace
<workspace>
¶
+-
+--workspace <workspace>¶
Path to workspace directory, archive, S3 or git repository
--
-
--workspaceRef
<workspace_ref>
¶
+-
+--workspaceRef <workspace_ref>¶
Git commit hash, branch name or tag
--
-
--workspacePassword
<workspace_password>
¶
+-
+--workspacePassword <workspace_password>¶
Workspace password
--
-
--ignoreFiles
<ignore_files>
¶
+-
+--ignoreFiles <ignore_files>¶
Ignore certain files from uploading
--
-
--workingDirectory
<working_directory>
¶
+-
+--workingDirectory <working_directory>¶
Working directory for the experiment
--
-
--artifactDirectory
<artifact_directory>
¶
+-
+--artifactDirectory <artifact_directory>¶
Artifacts directory
--
-
--experimentEnv
<experiment_env>
¶
+-
+--experimentEnv <experiment_env>¶
Environment variables in a JSON
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want add to experiment
--
-
--registryUsername
<registry_username>
¶
+-
+--registryUsername <registry_username>¶
Registry username
--
-
--datasetAwsAccessKeyId
<AWS access key>
¶
+-
+--datasetAwsAccessKeyId <AWS access key>¶
S3 bucket’s Access Key ID
--
-
--datasetAwsSecretAccessKey
<dataset_secret_access_key_list>
¶
+-
+--datasetAwsSecretAccessKey <dataset_secret_access_key_list>¶
S3 bucket’s Secret Access Key
--
-
--datasetAwsEndpoint
<dataset_endpoint_list>
¶
+-
+--datasetAwsEndpoint <dataset_endpoint_list>¶
S3 endpoint URL
--
-
--datasetVolumeKind
<dataset_volume_kind_list>
¶
+-
+--datasetVolumeKind <dataset_volume_kind_list>¶
S3 dataset’s volume kind. If used, –datasetVolumeSize has to be set as well
- Options
@@ -2475,44 +1605,44 @@ singlenode
--
-
--datasetVolumeSize
<dataset_volume_size_list>
¶
+-
+--datasetVolumeSize <dataset_volume_size_list>¶
S3 dataset’s volume size
--
-
--tensorboard_set
<tensorboard ID>
¶
+-
+--tensorboard_set <tensorboard ID>¶
Add to existing tensorboard
-
delete¶
Delete an experiment
gradient experiments delete [OPTIONS]
@@ -2520,31 +1650,31 @@ deleteOptions
-
details¶
Show detail of an experiment
gradient experiments details [OPTIONS]
@@ -2552,37 +1682,37 @@ detailsOptions
-
hyperparameters¶
Manage hyperparameters
gradient experiments hyperparameters [OPTIONS] COMMAND [ARGS]...
create¶
Create hyperparameter
gradient experiments hyperparameters create [OPTIONS]
@@ -2590,217 +1720,217 @@ createOptions
--
-
--workspace
<workspace>
¶
+-
+--workspace <workspace>¶
Path to workspace directory, archive, S3 or git repository
--
-
--workspaceRef
<workspace_ref>
¶
+-
+--workspaceRef <workspace_ref>¶
Git commit hash, branch name or tag
--
-
--workspacePassword
<workspace_password>
¶
+-
+--workspacePassword <workspace_password>¶
Workspace password
--
-
--ignoreFiles
<ignore_files>
¶
+-
+--ignoreFiles <ignore_files>¶
Ignore certain files from uploading
--
-
--workingDirectory
<working_directory>
¶
+-
+--workingDirectory <working_directory>¶
Working directory for the experiment
--
-
--artifactDirectory
<artifact_directory>
¶
+-
+--artifactDirectory <artifact_directory>¶
Artifacts directory
--
-
--experimentEnv
<experiment_env>
¶
+-
+--experimentEnv <experiment_env>¶
Environment variables in a JSON
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want add to experiment
--
-
--workerContainer
<worker_container>
¶
+-
+--workerContainer <worker_container>¶
Required Worker container
--
-
--workerContainerUser
<worker_container_user>
¶
+-
+--workerContainerUser <worker_container_user>¶
Worker container user
--
-
--workerMachineType
<worker_machine_type>
¶
+-
+--workerMachineType <worker_machine_type>¶
Required Worker machine type
--
-
--hyperparameterServerMachineType
<hyperparameter_server_machine_type>
¶
+-
+--hyperparameterServerMachineType <hyperparameter_server_machine_type>¶
Hyperparameter Server machine type
--
-
--workerRegistryUsername
<worker_registry_username>
¶
+-
+--workerRegistryUsername <worker_registry_username>¶
Worker registry username
--
-
--workerRegistryPassword
<worker_registry_password>
¶
+-
+--workerRegistryPassword <worker_registry_password>¶
Worker registry password
--
-
--hyperparameterServerRegistryUsername
<hyperparameter_server_registry_username>
¶
+-
+--hyperparameterServerRegistryUsername <hyperparameter_server_registry_username>¶
Hyperparameter server registry username
--
-
--hyperparameterServerRegistryPassword
<hyperparameter_server_registry_password>
¶
+-
+--hyperparameterServerRegistryPassword <hyperparameter_server_registry_password>¶
Hyperparameter server registry password
--
-
--hyperparameterServerContainer
<hyperparameter_server_container>
¶
+-
+--hyperparameterServerContainer <hyperparameter_server_container>¶
Hyperparameter server container
--
-
--hyperparameterServerContainerUser
<hyperparameter_server_container_user>
¶
+-
+--hyperparameterServerContainerUser <hyperparameter_server_container_user>¶
Hyperparameter server container user
-
details¶
Show details of hyperparameter
gradient experiments hyperparameters details [OPTIONS]
@@ -2808,31 +1938,31 @@ detailsOptions
-
list¶
List hyperparameters
gradient experiments hyperparameters list [OPTIONS]
@@ -2840,25 +1970,25 @@ list
Options
-
run¶
Create and start hyperparameter tuning job
gradient experiments hyperparameters run [OPTIONS]
@@ -2866,217 +1996,217 @@ run
Options
--
-
--workspace
<workspace>
¶
+-
+--workspace <workspace>¶
Path to workspace directory, archive, S3 or git repository
--
-
--workspaceRef
<workspace_ref>
¶
+-
+--workspaceRef <workspace_ref>¶
Git commit hash, branch name or tag
--
-
--workspacePassword
<workspace_password>
¶
+-
+--workspacePassword <workspace_password>¶
Workspace password
--
-
--ignoreFiles
<ignore_files>
¶
+-
+--ignoreFiles <ignore_files>¶
Ignore certain files from uploading
--
-
--workingDirectory
<working_directory>
¶
+-
+--workingDirectory <working_directory>¶
Working directory for the experiment
--
-
--artifactDirectory
<artifact_directory>
¶
+-
+--artifactDirectory <artifact_directory>¶
Artifacts directory
--
-
--experimentEnv
<experiment_env>
¶
+-
+--experimentEnv <experiment_env>¶
Environment variables in a JSON
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want add to experiment
--
-
--workerContainer
<worker_container>
¶
+-
+--workerContainer <worker_container>¶
Required Worker container
--
-
--workerContainerUser
<worker_container_user>
¶
+-
+--workerContainerUser <worker_container_user>¶
Worker container user
--
-
--workerMachineType
<worker_machine_type>
¶
+-
+--workerMachineType <worker_machine_type>¶
Required Worker machine type
--
-
--hyperparameterServerMachineType
<hyperparameter_server_machine_type>
¶
+-
+--hyperparameterServerMachineType <hyperparameter_server_machine_type>¶
Hyperparameter Server machine type
--
-
--workerRegistryUsername
<worker_registry_username>
¶
+-
+--workerRegistryUsername <worker_registry_username>¶
Worker registry username
--
-
--workerRegistryPassword
<worker_registry_password>
¶
+-
+--workerRegistryPassword <worker_registry_password>¶
Worker registry password
--
-
--hyperparameterServerRegistryUsername
<hyperparameter_server_registry_username>
¶
+-
+--hyperparameterServerRegistryUsername <hyperparameter_server_registry_username>¶
Hyperparameter server registry username
--
-
--hyperparameterServerRegistryPassword
<hyperparameter_server_registry_password>
¶
+-
+--hyperparameterServerRegistryPassword <hyperparameter_server_registry_password>¶
Hyperparameter server registry password
--
-
--hyperparameterServerContainer
<hyperparameter_server_container>
¶
+-
+--hyperparameterServerContainer <hyperparameter_server_container>¶
Hyperparameter server container
--
-
--hyperparameterServerContainerUser
<hyperparameter_server_container_user>
¶
+-
+--hyperparameterServerContainerUser <hyperparameter_server_container_user>¶
Hyperparameter server container user
-
start¶
Start hyperparameter tuning
gradient experiments hyperparameters start [OPTIONS]
@@ -3084,37 +2214,37 @@ startOptions
-
tags¶
Manage hyperparameter tags
gradient experiments hyperparameters tags [OPTIONS] COMMAND [ARGS]...
Add tags to hyperparameter
gradient experiments hyperparameters tags add [OPTIONS]
@@ -3122,43 +2252,43 @@ tags
Options
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want add to hyperparameter
-
Remove tags from hyperparameter
gradient experiments hyperparameters tags remove [OPTIONS]
@@ -3166,45 +2296,45 @@ tags
Options
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want to remove from hyperparameter
-
list¶
List experiments
gradient experiments list [OPTIONS]
@@ -3212,48 +2342,48 @@ listOptions
--
-
-p
,
--projectId
<project ID>
¶
+-
+-p, --projectId <project ID>¶
Filter by project IDs. Multiple use
-
logs¶
List experiment logs
gradient experiments logs [OPTIONS]
@@ -3261,52 +2391,52 @@ logsOptions
-
metrics¶
Read experiment metrics
gradient experiments metrics [OPTIONS] COMMAND [ARGS]...
get¶
Get experiment metrics. Shows CPU and RAM usage by default
gradient experiments metrics get [OPTIONS]
@@ -3314,55 +2444,55 @@ getOptions
--
-
--metric
<metrics_list>
¶
+-
+--metric <metrics_list>¶
One or more metrics that you want to read: cpuPercentage, memoryUsage, gpuMemoryFree, gpuMemoryUsed, gpuPowerDraw, gpuTemp, gpuUtilization, gpuMemoryUtilization. Defaults to cpuPercentage and memoryUsage. To view available custom metrics, use command: gradient experiments metrics list
-
list¶
List experiment metrics. Shows CPU and RAM usage by default
gradient experiments metrics list [OPTIONS]
@@ -3370,49 +2500,49 @@ listOptions
-
stream¶
Watch live experiment metrics. Shows CPU and RAM usage by default
gradient experiments metrics stream [OPTIONS]
@@ -3420,14 +2550,14 @@ stream
Options
run¶
Create and start new experiment
gradient experiments run [OPTIONS] COMMAND [ARGS]...
multinode¶
Create and start new multi node experiment
gradient experiments run multinode [OPTIONS]
@@ -3476,110 +2606,110 @@ multinode
Options
--
-
--workspace
<workspace>
¶
+-
+--workspace <workspace>¶
Path to workspace directory, archive, S3 or git repository
--
-
--workspaceRef
<workspace_ref>
¶
+-
+--workspaceRef <workspace_ref>¶
Git commit hash, branch name or tag
--
-
--workspacePassword
<workspace_password>
¶
+-
+--workspacePassword <workspace_password>¶
Workspace password
--
-
--ignoreFiles
<ignore_files>
¶
+-
+--ignoreFiles <ignore_files>¶
Ignore certain files from uploading
--
-
--workingDirectory
<working_directory>
¶
+-
+--workingDirectory <working_directory>¶
Working directory for the experiment
--
-
--artifactDirectory
<artifact_directory>
¶
+-
+--artifactDirectory <artifact_directory>¶
Artifacts directory
--
-
--experimentEnv
<experiment_env>
¶
+-
+--experimentEnv <experiment_env>¶
Environment variables in a JSON
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want add to experiment
--
-
--experimentType
<experiment_type_id>
¶
+-
+--experimentType <experiment_type_id>¶
Required Experiment Type
--
-
--workerMachineType
<machine type>
¶
+-
+--workerMachineType <machine type>¶
Required Worker machine type
--
-
--parameterServerContainer
<container>
¶
+-
+--parameterServerContainer <container>¶
Parameter server container (GRPC only)
--
-
--parameterServerMachineType
<machine type>
¶
+-
+--parameterServerMachineType <machine type>¶
Parameter server machine type (GRPC only)
--
-
--parameterServerCommand
<command>
¶
+-
+--parameterServerCommand <command>¶
Parameter server command (GRPC only)
--
-
--parameterServerCount
<parameter_server_count>
¶
+-
+--parameterServerCount <parameter_server_count>¶
Parameter server count (GRPC only)
--
-
--masterMachineType
<machine type>
¶
+-
+--masterMachineType <machine type>¶
Master machine type (MPI only)
--
-
--workerContainerUser
<worker_container_user>
¶
+-
+--workerContainerUser <worker_container_user>¶
Worker container user
--
-
--workerRegistryUsername
<worker_registry_username>
¶
+-
+--workerRegistryUsername <worker_registry_username>¶
Worker container registry username
--
-
--workerRegistryPassword
<password>
¶
+-
+--workerRegistryPassword <password>¶
Worker registry password
--
-
--parameterServerContainerUser
<parameter_server_container_user>
¶
+-
+--parameterServerContainerUser <parameter_server_container_user>¶
Parameter server container user
--
-
--parameterServerRegistryUsername
<parameter_server_registry_username>
¶
+-
+--parameterServerRegistryUsername <parameter_server_registry_username>¶
Parameter server registry username
--
-
--parameterServerRegistryPassword
<password>
¶
+-
+--parameterServerRegistryPassword <password>¶
Parameter server registry password
--
-
--parameterServerRegistryUrl
<registry url>
¶
+-
+--parameterServerRegistryUrl <registry url>¶
Parameter server registry URL
--
-
--masterContainerUser
<master_container_user>
¶
+-
+--masterContainerUser <master_container_user>¶
Master container user (MPI only)
--
-
--masterRegistryUsername
<username>
¶
+-
+--masterRegistryUsername <username>¶
Master registry username (MPI only)
--
-
--masterRegistryPassword
<password>
¶
+-
+--masterRegistryPassword <password>¶
Master registry password (MPI only)
--
-
--masterRegistryUrl
<registry url>
¶
+-
+--masterRegistryUrl <registry url>¶
Master registry URL (MPI only)
--
-
--datasetAwsAccessKeyId
<AWS access key>
¶
+-
+--datasetAwsAccessKeyId <AWS access key>¶
S3 bucket’s Access Key ID
--
-
--datasetAwsSecretAccessKey
<dataset_secret_access_key_list>
¶
+-
+--datasetAwsSecretAccessKey <dataset_secret_access_key_list>¶
S3 bucket’s Secret Access Key
--
-
--datasetAwsEndpoint
<dataset_endpoint_list>
¶
+-
+--datasetAwsEndpoint <dataset_endpoint_list>¶
S3 endpoint URL
--
-
--datasetVolumeKind
<dataset_volume_kind_list>
¶
+-
+--datasetVolumeKind <dataset_volume_kind_list>¶
S3 dataset’s volume kind. If used, –datasetVolumeSize has to be set as well
--
-
--datasetVolumeSize
<dataset_volume_size_list>
¶
+-
+--datasetVolumeSize <dataset_volume_size_list>¶
S3 dataset’s volume size
--
-
--tensorboard_set
<tensorboard ID>
¶
+-
+--tensorboard_set <tensorboard ID>¶
Add to existing tensorboard
-
singlenode¶
Create and start new single node experiment
gradient experiments run singlenode [OPTIONS]
@@ -3842,206 +2972,206 @@ singlenode
Options
--
-
--workspace
<workspace>
¶
+-
+--workspace <workspace>¶
Path to workspace directory, archive, S3 or git repository
--
-
--workspaceRef
<workspace_ref>
¶
+-
+--workspaceRef <workspace_ref>¶
Git commit hash, branch name or tag
--
-
--workspacePassword
<workspace_password>
¶
+-
+--workspacePassword <workspace_password>¶
Workspace password
--
-
--ignoreFiles
<ignore_files>
¶
+-
+--ignoreFiles <ignore_files>¶
Ignore certain files from uploading
--
-
--workingDirectory
<working_directory>
¶
+-
+--workingDirectory <working_directory>¶
Working directory for the experiment
--
-
--artifactDirectory
<artifact_directory>
¶
+-
+--artifactDirectory <artifact_directory>¶
Artifacts directory
--
-
--experimentEnv
<experiment_env>
¶
+-
+--experimentEnv <experiment_env>¶
Environment variables in a JSON
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want add to experiment
--
-
--registryUsername
<registry_username>
¶
+-
+--registryUsername <registry_username>¶
Registry username
--
-
--datasetAwsAccessKeyId
<AWS access key>
¶
+-
+--datasetAwsAccessKeyId <AWS access key>¶
S3 bucket’s Access Key ID
--
-
--datasetAwsSecretAccessKey
<dataset_secret_access_key_list>
¶
+-
+--datasetAwsSecretAccessKey <dataset_secret_access_key_list>¶
S3 bucket’s Secret Access Key
--
-
--datasetAwsEndpoint
<dataset_endpoint_list>
¶
+-
+--datasetAwsEndpoint <dataset_endpoint_list>¶
S3 endpoint URL
--
-
--datasetVolumeKind
<dataset_volume_kind_list>
¶
+-
+--datasetVolumeKind <dataset_volume_kind_list>¶
S3 dataset’s volume kind. If used, –datasetVolumeSize has to be set as well
--
-
--datasetVolumeSize
<dataset_volume_size_list>
¶
+-
+--datasetVolumeSize <dataset_volume_size_list>¶
S3 dataset’s volume size
--
-
--tensorboard_set
<tensorboard ID>
¶
+-
+--tensorboard_set <tensorboard ID>¶
Add to existing tensorboard
-
start¶
Start experiment
gradient experiments start [OPTIONS]
@@ -4096,37 +3226,37 @@ startOptions
-
stop¶
Stop experiment
gradient experiments stop [OPTIONS]
@@ -4134,37 +3264,37 @@ stopOptions
-
tags¶
Manage tags for experiment
gradient experiments tags [OPTIONS] COMMAND [ARGS]...
add¶
Add tags to experiment
gradient experiments tags add [OPTIONS]
@@ -4172,43 +3302,43 @@ addOptions
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want add to experiment
-
remove¶
Remove tags from experiment
gradient experiments tags remove [OPTIONS]
@@ -4216,57 +3346,57 @@ removeOptions
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want to remove from experiment
-
jobs¶
Manage gradient jobs
gradient jobs [OPTIONS] COMMAND [ARGS]...
artifacts¶
Manage jobs’ artifacts
gradient jobs artifacts [OPTIONS] COMMAND [ARGS]...
destroy¶
Destroy job’s artifacts
gradient jobs artifacts destroy [OPTIONS]
@@ -4274,36 +3404,36 @@ destroyOptions
-
download¶
List job’s artifacts
gradient jobs artifacts download [OPTIONS]
@@ -4311,36 +3441,36 @@ download
Options
-
get¶
Get job’s artifacts
gradient jobs artifacts get [OPTIONS]
@@ -4348,31 +3478,31 @@ getOptions
-
list¶
List job’s artifacts
gradient jobs artifacts list [OPTIONS]
@@ -4380,50 +3510,50 @@ listOptions
-
create¶
Create job
gradient jobs create [OPTIONS]
@@ -4431,199 +3561,199 @@ createOptions
--
-
--workingDirectory
<working_directory>
¶
+-
+--workingDirectory <working_directory>¶
Working directory for the experiment
--
-
--ignoreFiles
<ignore_files>
¶
+-
+--ignoreFiles <ignore_files>¶
Ignore certain files from uploading
--
-
--relDockerfilePath
<rel_dockerfile_path>
¶
+-
+--relDockerfilePath <rel_dockerfile_path>¶
Relative path to Dockerfile
--
-
--registryUsername
<registry_username>
¶
+-
+--registryUsername <registry_username>¶
Docker registry username
--
-
--registryPassword
<registry_password>
¶
+-
+--registryPassword <registry_password>¶
Docker registry password
--
-
--registryTarget
<registry_target>
¶
+-
+--registryTarget <registry_target>¶
Docker registry target
--
-
--registryTargetUsername
<registry_target_username>
¶
+-
+--registryTargetUsername <registry_target_username>¶
Docker registry username
--
-
--registryTargetPassword
<registry_target_password>
¶
+-
+--registryTargetPassword <registry_target_password>¶
Docker registry password
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want add to experiment
--
-
--dataset
<datasets>
¶
+-
+--dataset <datasets>¶
Separated by comma tags that you want add to experiment
-
delete¶
Delete job
gradient jobs delete [OPTIONS]
@@ -4631,19 +3761,19 @@ deleteOptions
-
list¶
List jobs with optional filtering
gradient jobs list [OPTIONS]
@@ -4651,49 +3781,49 @@ listOptions
--
-
--experimentId
<experiment_id>
¶
+-
+--experimentId <experiment_id>¶
Use to filter jobs by experiment ID
-
logs¶
List job logs
gradient jobs logs [OPTIONS]
@@ -4701,52 +3831,52 @@ logsOptions
-
metrics¶
Read job metrics
gradient jobs metrics [OPTIONS] COMMAND [ARGS]...
get¶
Get job metrics. Shows CPU and RAM usage by default
gradient jobs metrics get [OPTIONS]
@@ -4754,55 +3884,55 @@ getOptions
--
-
--metric
<metrics_list>
¶
+-
+--metric <metrics_list>¶
One or more metrics that you want to read: cpuPercentage, memoryUsage, gpuMemoryFree, gpuMemoryUsed, gpuPowerDraw, gpuTemp, gpuUtilization, gpuMemoryUtilization. Defaults to cpuPercentage and memoryUsage. To view available custom metrics, use command: gradient jobs metrics list
-
list¶
List job metrics. Shows CPU and RAM usage by default
gradient jobs metrics list [OPTIONS]
@@ -4810,49 +3940,49 @@ listOptions
-
stream¶
Watch live job metrics. Shows CPU and RAM usage by default
gradient jobs metrics stream [OPTIONS]
@@ -4860,14 +3990,14 @@ streamOptions
--
-
--metric
<metrics_list>
¶
+-
+--metric <metrics_list>¶
One or more metrics that you want to read. Defaults to cpuPercentage and memoryUsage
- Options
@@ -4877,32 +4007,32 @@ stream
--
-
--interval
<interval>
¶
+-
+--interval <interval>¶
Interval
-
stop¶
Stop running job
gradient jobs stop [OPTIONS]
@@ -4910,25 +4040,25 @@ stopOptions
-
tags¶
Manage job tags
gradient jobs tags [OPTIONS] COMMAND [ARGS]...
add¶
Add tags to job
gradient jobs tags add [OPTIONS]
@@ -4936,43 +4066,43 @@ addOptions
-
remove¶
Remove tags from job
gradient jobs tags remove [OPTIONS]
@@ -4980,58 +4110,58 @@ removeOptions
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want to remove from job
-
logout¶
Log out / remove apiKey from config file
gradient logout [OPTIONS]
machines¶
Manage machines
gradient machines [OPTIONS] COMMAND [ARGS]...
availability¶
Get machine availability for the given region and machine type. Note: availability is only provided for the dedicated GPU machine types. Also, not all machine types are available in all regions
gradient machines availability [OPTIONS]
@@ -5039,8 +4169,8 @@ availability
Options
create¶
Create a new Paperspace virtual machine. If you are using an individual account, you will be assigned as the owner of the machine. If you are a team administrator, you must specify the user that should be assigned to the machine, either by specifing a user id, or by providing an email address, password, first name and last name for the creation of a new user on the team.
gradient machines create [OPTIONS]
@@ -5082,8 +4212,8 @@ createOptions
--
-
--region
<region>
¶
+-
+--region <region>¶
Required Name of the region
- Options
@@ -5093,20 +4223,20 @@ create
--
-
--machineType
<machine_type>
¶
+-
+--machineType <machine_type>¶
Required Machine type
--
-
--billingType
<billing_type>
¶
+-
+--billingType <billing_type>¶
Required Either ‘monthly’ or ‘hourly’ billing
- Options
@@ -5116,115 +4246,115 @@ create
--
-
--machineName
<name>
¶
+-
+--machineName <name>¶
Required A memorable name for this machine
--
-
--templateId
<template_id>
¶
+-
+--templateId <template_id>¶
Required Template id of the template to use for creating this machine
--
-
--assignPublicIp
¶
+-
+--assignPublicIp¶
Assign a new public ip address on machine creation. Cannot be used with dynamicPublicIp
--
-
--dynamicPublicIp
¶
+-
+--dynamicPublicIp¶
Assigns a new public ip address on machine start and releases it from the account on machine stop. Cannot be used with assignPublicIp
--
-
--networkId
<network_id>
¶
+-
+--networkId <network_id>¶
If creating on a specific network, specify its id
--
-
--teamId
<team_id>
¶
+-
+--teamId <team_id>¶
If creating the machine for a team, specify the team id
--
-
--userId
<user_id>
¶
+-
+--userId <user_id>¶
If assigning to an existing user other than yourself, specify the user id (mutually exclusive with email, password, firstName, lastName)
--
-
--email
<email>
¶
+-
+--email <email>¶
If creating a new user for this machine, specify their email address (mutually exclusive with userId)
--
-
--password
<password>
¶
+-
+--password <password>¶
If creating a new user, specify their password (mutually exclusive with userId)
--
-
--firstName
<first_name>
¶
+-
+--firstName <first_name>¶
If creating a new user, specify their first name (mutually exclusive with userId)
--
-
--lastName
<last_name>
¶
+-
+--lastName <last_name>¶
If creating a new user, specify their last name (mutually exclusive with userId)
--
-
--notificationEmail
<notification_email>
¶
+-
+--notificationEmail <notification_email>¶
Send a notification to this email address when complete
--
-
--scriptId
<script_id>
¶
+-
+--scriptId <script_id>¶
The script id of a script to be run on startup. See the Script Guide for more info on using scripts
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want add to experiment
-
destroy¶
Destroy the machine with the given id. When this action is performed, the machine is immediately shut down and marked for deletion from the datacenter. Any snapshots that were derived from the machine are also deleted. Access to the machine is terminated immediately and billing for the machine is prorated to the hour. This action can only be performed by the user who owns the machine, or in the case of a team, the team administrator.
gradient machines destroy [OPTIONS]
@@ -5232,37 +4362,37 @@ destroyOptions
--
-
--releasePublicIp
¶
+-
+--releasePublicIp¶
releases any assigned public ip address for the machine; defaults to false
-
details¶
Show machine information for the machine with the given id.
gradient machines details [OPTIONS]
@@ -5270,31 +4400,31 @@ detailsOptions
-
list¶
List information about all machines available to either the current authenticated user or the team, if the user belongs to a team. The list method takes an optional first argument to limit the returned machine objects.
gradient machines list [OPTIONS]
@@ -5302,80 +4432,80 @@ listOptions
--
-
--params
<params>
¶
+-
+--params <params>¶
JSON used to filter machines. Use either this or a combination of following options
--
-
--shutdownTimeoutInHours
<shutdown_timeout_in_hours>
¶
+-
+--shutdownTimeoutInHours <shutdown_timeout_in_hours>¶
Filter by shutdown timeout
--
-
--performAutoSnapshot
<perform_auto_snapshot>
¶
+-
+--performAutoSnapshot <perform_auto_snapshot>¶
Filter by performAutoSnapshot flag
--
-
--autoSnapshotFrequency
<auto_snapshot_frequency>
¶
+-
+--autoSnapshotFrequency <auto_snapshot_frequency>¶
Filter by autoSnapshotFrequency flag
- Options
@@ -5385,56 +4515,56 @@ list
--
-
--autoSnapshotSaveCount
<auto_snapshot_save_count>
¶
+-
+--autoSnapshotSaveCount <auto_snapshot_save_count>¶
Filter by auto shapshots count
--
-
--updatesPending
<updates_pending>
¶
+-
+--updatesPending <updates_pending>¶
Filter by updatesPending
--
-
--privateIpAddress
<private_ip_address>
¶
+-
+--privateIpAddress <private_ip_address>¶
Filter by private IP address
--
-
--publicIpAddress
<public_ip_address>
¶
+-
+--publicIpAddress <public_ip_address>¶
Filter by public IP address
restart¶
Restart an individual machine. If the machine is already restarting, this action will request the machine be restarted again. This action can only be performed by the user who owns the machine
gradient machines restart [OPTIONS]
@@ -5488,31 +4618,31 @@ restartOptions
-
start¶
Start up an individual machine. If the machine is already started, this action is a no-op. If the machine is off, it will be booted up. This action can only be performed by the user who owns the machine
gradient machines start [OPTIONS]
@@ -5520,31 +4650,31 @@ startOptions
-
stop¶
Stop an individual machine. If the machine is already stopped or has been shut down, this action is a no-op. If the machine is running, it will be stopped and any users logged in will be immediately kicked out. This action can only be performed by the user who owns the machine
gradient machines stop [OPTIONS]
@@ -5552,37 +4682,37 @@ stopOptions
-
tags¶
Manage machine tags
gradient machines tags [OPTIONS] COMMAND [ARGS]...
add¶
Add tags to machine
gradient machines tags add [OPTIONS]
@@ -5590,43 +4720,43 @@ addOptions
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want add to machine
-
remove¶
Remove tags from machine
gradient machines tags remove [OPTIONS]
@@ -5634,44 +4764,44 @@ removeOptions
--
-
--tags
<tags_comma>
¶
+-
+--tags <tags_comma>¶
Separated by comma tags that you want to remove from machine
-
update¶
Update attributes of a machine
gradient machines update [OPTIONS]
@@ -5679,38 +4809,38 @@ updateOptions
--
-
--shutdownTimeoutInHours
<shutdown_timeout_in_hours>
¶
+-
+--shutdownTimeoutInHours <shutdown_timeout_in_hours>¶
Number of hours before machine is shutdown if no one is logged in via the Paperspace client
--
-
--shutdownTimeoutForces
<shutdown_timeout_forces>
¶
+-
+--shutdownTimeoutForces <shutdown_timeout_forces>¶
Force shutdown at shutdown timeout, even if there is a Paperspace client connection