Interface InstancePreference.Builder

All Superinterfaces:
Buildable, CopyableBuilder<InstancePreference.Builder,InstancePreference>, SdkBuilder<InstancePreference.Builder,InstancePreference>, SdkPojo
Enclosing class:
InstancePreference
@Mutable @NotThreadSafe public static interface InstancePreference.Builder extends SdkPojo, CopyableBuilder<InstancePreference.Builder,InstancePreference>

  • Method Details

    • instanceType

      InstancePreference.Builder instanceType(String instanceType)

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

      Parameters:
      instanceType - The ML compute instance type. An instance type can appear only once in an InstancePreferences list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceType

      InstancePreference.Builder instanceType(TrainingInstanceType instanceType)

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

      Parameters:
      instanceType - The ML compute instance type. An instance type can appear only once in an InstancePreferences list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceCount

      InstancePreference.Builder instanceCount(Integer instanceCount)

      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.

      Parameters:
      instanceCount - 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:
      Returns a reference to this object so that method calls can be chained together.

    • trainingPlanArns

      InstancePreference.Builder trainingPlanArns(Collection<String> trainingPlanArns)

      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.

      Parameters:
      trainingPlanArns - 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:
      Returns a reference to this object so that method calls can be chained together.

    • trainingPlanArns

      InstancePreference.Builder trainingPlanArns(String... trainingPlanArns)

      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.

      Parameters:
      trainingPlanArns - 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:
      Returns a reference to this object so that method calls can be chained together.