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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass CreateCompilationJobRequest data as a 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, MXNET, ONNX, PYTORCH, XGBOOST
  },
  output_config: { # required
    s3_output_location: "S3Uri", # required
    target_device: "lambda", # required, accepts lambda, ml_m4, ml_m5, ml_c4, ml_c5, ml_p2, ml_p3, ml_inf1, jetson_tx1, jetson_tx2, jetson_nano, rasp3b, deeplens, rk3399, rk3288, aisage, sbe_c, qcs605, qcs603
  },
  stopping_condition: { # required
    max_runtime_in_seconds: 1,
    max_wait_time_in_seconds: 1,
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns:

  • (String) 


2468
2469
2470
2471
2472
2473
2474
2475
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2468

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :input_config,
  :output_config,
  :stopping_condition)
  include Aws::Structure
end

#input_config ⇒ 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.

Returns:



2468
2469
2470
2471
2472
2473
2474
2475
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2468

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :input_config,
  :output_config,
  :stopping_condition)
  include Aws::Structure
end

#output_config ⇒ Types::OutputConfig

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

Returns:



2468
2469
2470
2471
2472
2473
2474
2475
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2468

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :input_config,
  :output_config,
  :stopping_condition)
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html

Returns:

  • (String) 


2468
2469
2470
2471
2472
2473
2474
2475
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2468

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :input_config,
  :output_config,
  :stopping_condition)
  include Aws::Structure
end

#stopping_condition ⇒ Types::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:



2468
2469
2470
2471
2472
2473
2474
2475
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2468

class CreateCompilationJobRequest < Struct.new(
  :compilation_job_name,
  :role_arn,
  :input_config,
  :output_config,
  :stopping_condition)
  include Aws::Structure
end