describe-compilation-job¶

Description¶

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob . To get information about multiple model compilation jobs, use ListCompilationJobs .

Synopsis¶

  describe-compilation-job
--compilation-job-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--compilation-job-name (string)

The name of the model compilation job that you want information about.

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

Output¶

CompilationJobName -> (string)

The name of the model compilation job.

CompilationJobArn -> (string)

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

CompilationJobStatus -> (string)

The status of the model compilation job.

CompilationStartTime -> (timestamp)

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That’s because it takes time to download the compilation job, which depends on the size of the compilation job container.

CompilationEndTime -> (timestamp)

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job’s model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

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

MaxRuntimeInSeconds -> (integer)

The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.

MaxWaitTimeInSeconds -> (integer)

The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .

CreationTime -> (timestamp)

The time that the model compilation job was created.

LastModifiedTime -> (timestamp)

The time that the status of the model compilation job was last modified.

FailureReason -> (string)

If a model compilation job failed, the reason it failed.

ModelArtifacts -> (structure)

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

S3ModelArtifacts -> (string)

The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz .

ModelDigests -> (structure)

Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

ArtifactDigest -> (string)

Provides a hash value that uniquely identifies the stored model artifacts.

RoleArn -> (string)

The Amazon Resource Name (ARN) of the model compilation job.

InputConfig -> (structure)

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

S3Uri -> (string)

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

DataInputConfig -> (string)

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.

TensorFlow : You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

Examples for one input:

If using the console, {"input":[1,1024,1024,3]}

If using the CLI, {\"input\":[1,1024,1024,3]}

Examples for two inputs:

If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]}

If using the CLI, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}

KERAS : You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.

Examples for one input:

If using the console, {"input_1":[1,3,224,224]}

If using the CLI, {\"input_1\":[1,3,224,224]}

Examples for two inputs:

If using the console, {"input_1": [1,3,224,224], "input_2":[1,3,224,224]}

If using the CLI, {\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]}

MXNET/ONNX/DARKNET : You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

Examples for one input:

If using the console, {"data":[1,3,1024,1024]}

If using the CLI, {\"data\":[1,3,1024,1024]}

Examples for two inputs:

If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]}

If using the CLI, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}

PyTorch : You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.

Examples for one input in dictionary format:

If using the console, {"input0":[1,3,224,224]}

If using the CLI, {\"input0\":[1,3,224,224]}

Example for one input in list format: [[1,3,224,224]]

Examples for two inputs in dictionary format:

If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]}

If using the CLI, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}

Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]

XGBOOST : input data name and shape are not needed.

DataInputConfig supports the following parameters for CoreML OutputConfig$TargetDevice (ML Model format):

shape : Input shape, for example {"input_1": {"shape": [1,224,224,3]}} . In addition to static input shapes, CoreML converter supports Flexible input shapes:

Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {"input_1": {"shape": ["1..10", 224, 224, 3]}}

Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {"input_1": {"shape": [[1, 224, 224, 3], [1, 160, 160, 3]]}}

default_shape : Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {"input_1": {"shape": ["1..10", 224, 224, 3], "default_shape": [1, 224, 224, 3]}}

type : Input type. Allowed values: Image and Tensor . By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale .

bias : If the input type is an Image, you need to provide the bias vector.

scale : If the input type is an Image, you need to provide a scale factor.

CoreML ClassifierConfig parameters can be specified using OutputConfig$CompilerOptions . CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:

Tensor type input:

"DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3]}}

Tensor type input without input name (PyTorch):

"DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224]}]

Image type input:

"DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}}

"CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}

Image type input without input name (PyTorch):

"DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}]

"CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}

Framework -> (string)

Identifies the framework in which the model was trained. For example: TENSORFLOW.

OutputConfig -> (structure)

Information about the output location for the compiled model and the target device that the model runs on.

S3OutputLocation -> (string)

Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .

TargetDevice -> (string)

Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform .

TargetPlatform -> (structure)

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice .

The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings for popular target platforms:

Raspberry Pi 3 Model B+ "TargetPlatform": {"Os": "LINUX", "Arch": "ARM_EABIHF"}, "CompilerOptions": {'mattr': ['+neon']}

Jetson TX2 "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "NVIDIA"}, "CompilerOptions": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1', 'cuda-ver': '10.0'}

EC2 m5.2xlarge instance OS "TargetPlatform": {"Os": "LINUX", "Arch": "X86_64", "Accelerator": "NVIDIA"}, "CompilerOptions": {'mcpu': 'skylake-avx512'}

RK3399 "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "MALI"}

ARMv7 phone (CPU) "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM_EABI"}, "CompilerOptions": {'ANDROID_PLATFORM': 25, 'mattr': ['+neon']}

ARMv8 phone (CPU) "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM64"}, "CompilerOptions": {'ANDROID_PLATFORM': 29}

Os -> (string)

Specifies a target platform OS.

LINUX : Linux-based operating systems.

ANDROID : Android operating systems. Android API level can be specified using the ANDROID_PLATFORM compiler option. For example, "CompilerOptions": {'ANDROID_PLATFORM': 28}

Arch -> (string)

Specifies a target platform architecture.

X86_64 : 64-bit version of the x86 instruction set.

X86 : 32-bit version of the x86 instruction set.

ARM64 : ARMv8 64-bit CPU.

ARM_EABIHF : ARMv7 32-bit, Hard Float.

ARM_EABI : ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.

Accelerator -> (string)

Specifies a target platform accelerator (optional).

NVIDIA : Nvidia graphics processing unit. It also requires gpu-code , trt-ver , cuda-ver compiler options

MALI : ARM Mali graphics processor

INTEL_GRAPHICS : Integrated Intel graphics

CompilerOptions -> (string)

Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.

CPU : Compilation for CPU supports the following compiler options.

mcpu : CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}

mattr : CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}

ARM : Details of ARM CPU compilations.

NEON : NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors. For example, add {'mattr': ['+neon']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.

NVIDIA : Compilation for NVIDIA GPU supports the following compiler options.

gpu_code : Specifies the targeted architecture.

trt-ver : Specifies the TensorRT versions in x.y.z. format.

cuda-ver : Specifies the CUDA version in x.y format.

For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'}

ANDROID : Compilation for the Android OS supports the following compiler options:

ANDROID_PLATFORM : Specifies the Android API levels. Available levels range from 21 to 29. For example, {'ANDROID_PLATFORM': 28} .

mattr : Add {'mattr': ['+neon']} to compiler options if compiling for ARM 32-bit platform with NEON support.

INFERENTIA : Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, "CompilerOptions": "\"--verbose 1 --num-neuroncores 2 -O2\"" . For information about supported compiler options, see Neuron Compiler CLI .

CoreML : Compilation for the CoreML OutputConfig$TargetDevice supports the following compiler options:

class_labels : Specifies the classification labels file name inside input tar.gz file. For example, {"class_labels": "imagenet_labels_1000.txt"} . Labels inside the txt file should be separated by newlines.

KmsKeyId -> (string)

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don’t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role’s account

The KmsKeyId can be any of the following formats:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Alias name: alias/ExampleAlias

Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

Table of Contents

Feedback

User Guide

describe-compilation-job¶

Description¶

Synopsis¶

Options¶

Output¶