/AWS1/CL_SGM=>CREATECOMPILATIONJOB()¶
About CreateCompilationJob¶
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 Amazon Web Services 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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_COMPILATIONJOBNAME TYPE /AWS1/SGMENTITYNAME /AWS1/SGMENTITYNAME¶
A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
IV_ROLEARN TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN¶
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:PassRolepermission. For more information, see Amazon SageMaker Roles.
IO_OUTPUTCONFIG TYPE REF TO /AWS1/CL_SGMOUTPUTCONFIG /AWS1/CL_SGMOUTPUTCONFIG¶
Provides information about the output location for the compiled model and the target device the model runs on.
IO_STOPPINGCONDITION TYPE REF TO /AWS1/CL_SGMSTOPPINGCONDITION /AWS1/CL_SGMSTOPPINGCONDITION¶
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.
Optional arguments:¶
IV_MODELPACKAGEVERSIONARN TYPE /AWS1/SGMMODELPACKAGEARN /AWS1/SGMMODELPACKAGEARN¶
The Amazon Resource Name (ARN) of a versioned model package. Provide either a
ModelPackageVersionArnor anInputConfigobject in the request syntax. The presence of both objects in theCreateCompilationJobrequest will return an exception.
IO_INPUTCONFIG TYPE REF TO /AWS1/CL_SGMINPUTCONFIG /AWS1/CL_SGMINPUTCONFIG¶
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.
IO_VPCCONFIG TYPE REF TO /AWS1/CL_SGMNEOVPCCONFIG /AWS1/CL_SGMNEOVPCCONFIG¶
A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
IT_TAGS TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST TT_TAGLIST¶
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.