You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SageMaker::Types::CreateCompilationJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateCompilationJobRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  compilation_job_name: "EntityName", # required
  role_arn: "RoleArn", # required
  input_config: { # required
    s3_uri: "S3Uri", # required
    data_input_config: "DataInputConfig", # required
    framework: "TENSORFLOW", # required, accepts TENSORFLOW, KERAS, MXNET, ONNX, PYTORCH, XGBOOST, TFLITE, DARKNET
  },
  output_config: { # required
    s3_output_location: "S3Uri", # required
    target_device: "lambda", # accepts lambda, ml_m4, ml_m5, ml_c4, ml_c5, ml_p2, ml_p3, ml_g4dn, ml_inf1, jetson_tx1, jetson_tx2, jetson_nano, jetson_xavier, rasp3b, imx8qm, deeplens, rk3399, rk3288, aisage, sbe_c, qcs605, qcs603, sitara_am57x, amba_cv22, x86_win32, x86_win64, coreml
    target_platform: {
      os: "ANDROID", # required, accepts ANDROID, LINUX
      arch: "X86_64", # required, accepts X86_64, X86, ARM64, ARM_EABI, ARM_EABIHF
      accelerator: "INTEL_GRAPHICS", # accepts INTEL_GRAPHICS, MALI, NVIDIA
    },
    compiler_options: "CompilerOptions",
  },
  stopping_condition: { # required
    max_runtime_in_seconds: 1,
    max_wait_time_in_seconds: 1,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#compilation_job_nameString

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

Returns:

  • (String)

    A name for the model compilation job.

#input_configTypes::InputConfig

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.

Returns:

  • (Types::InputConfig)

    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.

#output_configTypes::OutputConfig

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

Returns:

  • (Types::OutputConfig)

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

#role_arnString

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.

Returns:

  • (String)

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

#stopping_conditionTypes::StoppingCondition

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.

Returns:

#tagsArray<Types::Tag>

An array of key-value pairs that you want to use to organize and track your AWS resource costs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Returns:

  • (Array<Types::Tag>)

    An array of key-value pairs that you want to use to organize and track your AWS resource costs.