Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . sagemaker ]

create-compilation-job

Description

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with AWS IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

  • A name for the compilation job
  • Information about the input model artifacts
  • The output location for the compiled model and the device (target) that the model runs on
  • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job

You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob . To get information about a particular model compilation job, use DescribeCompilationJob . To get information about multiple model compilation jobs, use ListCompilationJobs .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-compilation-job
--compilation-job-name <value>
--role-arn <value>
--input-config <value>
--output-config <value>
--stopping-condition <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--compilation-job-name (string)

A name for the model compilation job. The name must be unique within the AWS Region and within your AWS account.

--role-arn (string)

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model compilation, Amazon SageMaker needs your permission to:

  • Read input data from an S3 bucket
  • Write model artifacts to an S3 bucket
  • Write logs to Amazon CloudWatch Logs
  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

--input-config (structure)

Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

Shorthand Syntax:

S3Uri=string,DataInputConfig=string,Framework=string

JSON Syntax:

{
  "S3Uri": "string",
  "DataInputConfig": "string",
  "Framework": "TENSORFLOW"|"MXNET"|"ONNX"|"PYTORCH"|"XGBOOST"
}

--output-config (structure)

Provides information about the output location for the compiled model and the target device the model runs on.

Shorthand Syntax:

S3OutputLocation=string,TargetDevice=string

JSON Syntax:

{
  "S3OutputLocation": "string",
  "TargetDevice": "lambda"|"ml_m4"|"ml_m5"|"ml_c4"|"ml_c5"|"ml_p2"|"ml_p3"|"jetson_tx1"|"jetson_tx2"|"jetson_nano"|"rasp3b"|"deeplens"|"rk3399"|"rk3288"|"aisage"|"sbe_c"|"qcs605"|"qcs603"
}

--stopping-condition (structure)

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

Shorthand Syntax:

MaxRuntimeInSeconds=integer,MaxWaitTimeInSeconds=integer

JSON Syntax:

{
  "MaxRuntimeInSeconds": integer,
  "MaxWaitTimeInSeconds": integer
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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.

Output

CompilationJobArn -> (string)

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format:

  • CompilationJobArn : The Amazon Resource Name (ARN) of the compiled job.