create-job¶
Description¶
Creates an Amazon Braket job.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-job
--algorithm-specification <value>
[--checkpoint-config <value>]
[--client-token <value>]
--device-config <value>
[--hyper-parameters <value>]
[--input-data-config <value>]
--instance-config <value>
--job-name <value>
--output-data-config <value>
--role-arn <value>
[--stopping-condition <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--algorithm-specification (structure)
Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.
containerImage -> (structure)
The container image used to create an Amazon Braket job.
uri -> (string)
The URI locating the container image.
scriptModeConfig -> (structure)
Configures the paths to the Python scripts used for entry and training.
compressionType -> (string)
The type of compression used by the Python scripts for an Amazon Braket job.
entryPoint -> (string)
The path to the Python script that serves as the entry point for an Amazon Braket job.
s3Uri -> (string)
The URI that specifies the S3 path to the Python script module that contains the training script used by an Amazon Braket job.
Shorthand Syntax:
containerImage={uri=string},scriptModeConfig={compressionType=string,entryPoint=string,s3Uri=string}
JSON Syntax:
{
"containerImage": {
"uri": "string"
},
"scriptModeConfig": {
"compressionType": "NONE"|"GZIP",
"entryPoint": "string",
"s3Uri": "string"
}
}
--checkpoint-config (structure)
Information about the output locations for job checkpoint data.
localPath -> (string)
(Optional) The local directory where checkpoints are written. The default directory is
/opt/braket/checkpoints/.s3Uri -> (string)
Identifies the S3 path where you want Amazon Braket to store checkpoints. For example,
s3://bucket-name/key-name-prefix.
Shorthand Syntax:
localPath=string,s3Uri=string
JSON Syntax:
{
"localPath": "string",
"s3Uri": "string"
}
--client-token (string)
A unique token that guarantees that the call to this API is idempotent.
--device-config (structure)
The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
device -> (string)
The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.
Shorthand Syntax:
device=string
JSON Syntax:
{
"device": "string"
}
--hyper-parameters (map)
Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--input-data-config (list)
A list of parameters that specify the name and type of input data and where it is located.
(structure)
A list of parameters that specify the input channels, type of input data, and where it is located.
channelName -> (string)
A named input source that an Amazon Braket job can consume.
contentType -> (string)
The MIME type of the data.
dataSource -> (structure)
The location of the channel data.
s3DataSource -> (structure)
Information about the data stored in Amazon S3 used by the Amazon Braket job.
s3Uri -> (string)
Depending on the value specified for the
S3DataType, identifies either a key name prefix or a manifest that locates the S3 data source.
Shorthand Syntax:
channelName=string,contentType=string,dataSource={s3DataSource={s3Uri=string}} ...
JSON Syntax:
[
{
"channelName": "string",
"contentType": "string",
"dataSource": {
"s3DataSource": {
"s3Uri": "string"
}
}
}
...
]
--instance-config (structure)
Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
instanceType -> (string)
Configures the type resource instances to use while running an Amazon Braket hybrid job.
volumeSizeInGb -> (integer)
The size of the storage volume, in GB, that user wants to provision.
Shorthand Syntax:
instanceType=string,volumeSizeInGb=integer
JSON Syntax:
{
"instanceType": "ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.p3dn.24xlarge"|"ml.p4d.24xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.c5n.xlarge"|"ml.c5n.2xlarge"|"ml.c5n.4xlarge"|"ml.c5n.9xlarge"|"ml.c5n.18xlarge",
"volumeSizeInGb": integer
}
--job-name (string)
The name of the Amazon Braket job.
--output-data-config (structure)
The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
kmsKeyId -> (string)
The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job training artifacts at rest using Amazon S3 server-side encryption.
s3Path -> (string)
Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For example,
s3://bucket-name/key-name-prefix.
Shorthand Syntax:
kmsKeyId=string,s3Path=string
JSON Syntax:
{
"kmsKeyId": "string",
"s3Path": "string"
}
--role-arn (string)
The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users’ s3 buckets.
--stopping-condition (structure)
The user-defined criteria that specifies when a job stops running.
maxRuntimeInSeconds -> (integer)
The maximum length of time, in seconds, that an Amazon Braket job can run.
Shorthand Syntax:
maxRuntimeInSeconds=integer
JSON Syntax:
{
"maxRuntimeInSeconds": integer
}
--tags (map)
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.