Class: Aws::SageMaker::Types::CreateOptimizationJobRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deployment_instance_type ⇒ String

The type of instance that hosts the optimized model that you create with the optimization job.

Returns:

  • (String) 


9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9071

class CreateOptimizationJobRequest < Struct.new(
  :optimization_job_name,
  :role_arn,
  :model_source,
  :deployment_instance_type,
  :optimization_environment,
  :optimization_configs,
  :output_config,
  :stopping_condition,
  :tags,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#model_source ⇒ Types::OptimizationJobModelSource

The location of the source model to optimize with an optimization job.

Returns:



9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9071

class CreateOptimizationJobRequest < Struct.new(
  :optimization_job_name,
  :role_arn,
  :model_source,
  :deployment_instance_type,
  :optimization_environment,
  :optimization_configs,
  :output_config,
  :stopping_condition,
  :tags,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_configs ⇒ Array<Types::OptimizationConfig>

Settings for each of the optimization techniques that the job applies.

Returns:



9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9071

class CreateOptimizationJobRequest < Struct.new(
  :optimization_job_name,
  :role_arn,
  :model_source,
  :deployment_instance_type,
  :optimization_environment,
  :optimization_configs,
  :output_config,
  :stopping_condition,
  :tags,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_environment ⇒ Hash<String,String>

The environment variables to set in the model container.

Returns:

  • (Hash<String,String>) 


9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9071

class CreateOptimizationJobRequest < Struct.new(
  :optimization_job_name,
  :role_arn,
  :model_source,
  :deployment_instance_type,
  :optimization_environment,
  :optimization_configs,
  :output_config,
  :stopping_condition,
  :tags,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_job_name ⇒ String

A custom name for the new optimization job.

Returns:

  • (String) 


9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9071

class CreateOptimizationJobRequest < Struct.new(
  :optimization_job_name,
  :role_arn,
  :model_source,
  :deployment_instance_type,
  :optimization_environment,
  :optimization_configs,
  :output_config,
  :stopping_condition,
  :tags,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#output_config ⇒ Types::OptimizationJobOutputConfig

Details for where to store the optimized model that you create with the optimization job.

Returns:



9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9071

class CreateOptimizationJobRequest < Struct.new(
  :optimization_job_name,
  :role_arn,
  :model_source,
  :deployment_instance_type,
  :optimization_environment,
  :optimization_configs,
  :output_config,
  :stopping_condition,
  :tags,
  :vpc_config)
  SENSITIVE = []
  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 optimization, 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) 


9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9071

class CreateOptimizationJobRequest < Struct.new(
  :optimization_job_name,
  :role_arn,
  :model_source,
  :deployment_instance_type,
  :optimization_environment,
  :optimization_configs,
  :output_config,
  :stopping_condition,
  :tags,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#stopping_condition ⇒ Types::StoppingCondition

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

To stop a training job, SageMaker sends the algorithm the ‘SIGTERM` signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with ‘CreateModel`.

<note markdown=“1”> The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

</note>

Returns:



9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9071

class CreateOptimizationJobRequest < Struct.new(
  :optimization_job_name,
  :role_arn,
  :model_source,
  :deployment_instance_type,
  :optimization_environment,
  :optimization_configs,
  :output_config,
  :stopping_condition,
  :tags,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of key-value pairs associated with the optimization job. For more information, see [Tagging Amazon Web Services resources] in the *Amazon Web Services General Reference Guide*.

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:



9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9071

class CreateOptimizationJobRequest < Struct.new(
  :optimization_job_name,
  :role_arn,
  :model_source,
  :deployment_instance_type,
  :optimization_environment,
  :optimization_configs,
  :output_config,
  :stopping_condition,
  :tags,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::OptimizationVpcConfig

A VPC in Amazon VPC that your optimized model has access to.

Returns:



9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 9071

class CreateOptimizationJobRequest < Struct.new(
  :optimization_job_name,
  :role_arn,
  :model_source,
  :deployment_instance_type,
  :optimization_environment,
  :optimization_configs,
  :output_config,
  :stopping_condition,
  :tags,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end