Class: Aws::SageMaker::Types::InstancePreference

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

Overview

A candidate instance type preference in an InstancePreferences list.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#instance_count ⇒ Integer

The number of instances to launch if this instance type is selected. Specify the instance count for the training job in one of the following two ways:

  1. Per preference – Set InstanceCount on every preference in the InstancePreferences list and don't set ResourceConfig$InstanceCount. Use this when each instance type needs a different number of instances to deliver equivalent compute.

  2. One count for the job – Set ResourceConfig$InstanceCount and omit it from every preference. SageMaker applies this to all instance types in the list.

For example, in a list of five preferences, either all five specify InstanceCount or none of them do. SageMaker rejects requests that set InstanceCount on only some preferences, that set it both per preference and in ResourceConfig, or that omit it in both places.

Returns:

  • (Integer)


33024
33025
33026
33027
33028
33029
33030
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 33024

class InstancePreference < Struct.new(
  :instance_type,
  :instance_count,
  :training_plan_arns)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ String

The ML compute instance type. An instance type can appear only once in an InstancePreferences list.

Returns:

  • (String)


33024
33025
33026
33027
33028
33029
33030
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 33024

class InstancePreference < Struct.new(
  :instance_type,
  :instance_count,
  :training_plan_arns)
  SENSITIVE = []
  include Aws::Structure
end

#training_plan_arns ⇒ Array<String>

The Amazon Resource Name (ARN) of a training plan to use if this instance type is selected. The plan's instance type must match InstanceType. A preference with a training plan uses that plan's reserved capacity; a preference without one uses on-demand capacity. Per-preference TrainingPlanArns is mutually exclusive with the job-level TrainingPlanArn in ResourceConfig.

Returns:

  • (Array<String>)


33024
33025
33026
33027
33028
33029
33030
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 33024

class InstancePreference < Struct.new(
  :instance_type,
  :instance_count,
  :training_plan_arns)
  SENSITIVE = []
  include Aws::Structure
end