Create Job

braket_create_job

R Documentation

Creates an Amazon Braket hybrid job

Description

Creates an Amazon Braket hybrid job.

Usage

braket_create_job(clientToken, algorithmSpecification, inputDataConfig,
  outputDataConfig, checkpointConfig, jobName, roleArn, stoppingCondition,
  instanceConfig, hyperParameters, deviceConfig, tags, associations)

Arguments

clientToken	[required] The client token associated with this request that guarantees that the request is idempotent.
algorithmSpecification	[required] 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.
inputDataConfig	A list of parameters that specify the name and type of input data and where it is located.
outputDataConfig	[required] The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.
checkpointConfig	Information about the output locations for hybrid job checkpoint data.
jobName	[required] The name of the Amazon Braket hybrid job.
roleArn	[required] 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 results and hybrid job details to the users' s3 buckets.
stoppingCondition	The user-defined criteria that specifies when a hybrid job stops running.
instanceConfig	[required] Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
hyperParameters	Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter. Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.
deviceConfig	[required] The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.
tags	Tags to be added to the hybrid job you're creating.
associations	The list of Amazon Braket resources associated with the hybrid job.

Value

A list with the following syntax:

list(
  jobArn = "string"
)

Request syntax

svc$create_job(
  clientToken = "string",
  algorithmSpecification = list(
    scriptModeConfig = list(
      entryPoint = "string",
      s3Uri = "string",
      compressionType = "NONE"|"GZIP"
    ),
    containerImage = list(
      uri = "string"
    )
  ),
  inputDataConfig = list(
    list(
      channelName = "string",
      contentType = "string",
      dataSource = list(
        s3DataSource = list(
          s3Uri = "string"
        )
      )
    )
  ),
  outputDataConfig = list(
    kmsKeyId = "string",
    s3Path = "string"
  ),
  checkpointConfig = list(
    localPath = "string",
    s3Uri = "string"
  ),
  jobName = "string",
  roleArn = "string",
  stoppingCondition = list(
    maxRuntimeInSeconds = 123
  ),
  instanceConfig = list(
    instanceType = "ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.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.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"|"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.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|"ml.g6.xlarge"|"ml.g6.2xlarge"|"ml.g6.4xlarge"|"ml.g6.8xlarge"|"ml.g6.12xlarge"|"ml.g6.16xlarge"|"ml.g6.24xlarge"|"ml.g6.48xlarge"|"ml.g6e.xlarge"|"ml.g6e.2xlarge"|"ml.g6e.4xlarge"|"ml.g6e.8xlarge"|"ml.g6e.12xlarge"|"ml.g6e.16xlarge"|"ml.g6e.24xlarge"|"ml.g6e.48xlarge",
    volumeSizeInGb = 123,
    instanceCount = 123
  ),
  hyperParameters = list(
    "string"
  ),
  deviceConfig = list(
    device = "string"
  ),
  tags = list(
    "string"
  ),
  associations = list(
    list(
      arn = "string",
      type = "RESERVATION_TIME_WINDOW_ARN"
    )
  )
)