Class: Aws::SageMaker::Types::HyperParameterTuningResourceConfig

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

Overview

Note:

When making an API call, you may pass HyperParameterTuningResourceConfig data as a hash:

{
  instance_type: "ml.m4.xlarge", # accepts ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.p4d.24xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.c5n.xlarge, ml.c5n.2xlarge, ml.c5n.4xlarge, ml.c5n.9xlarge, ml.c5n.18xlarge, ml.g5.xlarge, ml.g5.2xlarge, ml.g5.4xlarge, ml.g5.8xlarge, ml.g5.16xlarge, ml.g5.12xlarge, ml.g5.24xlarge, ml.g5.48xlarge, ml.trn1.2xlarge, ml.trn1.32xlarge
  instance_count: 1,
  volume_size_in_gb: 1,
  volume_kms_key_id: "KmsKeyId",
  allocation_strategy: "Prioritized", # accepts Prioritized
  instance_configs: [
    {
      instance_type: "ml.m4.xlarge", # required, accepts ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.p4d.24xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.c5n.xlarge, ml.c5n.2xlarge, ml.c5n.4xlarge, ml.c5n.9xlarge, ml.c5n.18xlarge, ml.g5.xlarge, ml.g5.2xlarge, ml.g5.4xlarge, ml.g5.8xlarge, ml.g5.16xlarge, ml.g5.12xlarge, ml.g5.24xlarge, ml.g5.48xlarge, ml.trn1.2xlarge, ml.trn1.32xlarge
      instance_count: 1, # required
      volume_size_in_gb: 1, # required
    },
  ],
}

The configuration of resources, including compute instances and storage volumes for use in training jobs launched by hyperparameter tuning jobs. Specify one or more instance type and count and the allocation strategy for instance selection.

HyperParameterTuningResourceConfig supports all of the capabilities of ResourceConfig with added functionality for flexible instance management.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocation_strategyString

The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.

Returns:

  • (String)


23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 23417

class HyperParameterTuningResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :allocation_strategy,
  :instance_configs)
  SENSITIVE = []
  include Aws::Structure
end

#instance_configsArray<Types::HyperParameterTuningInstanceConfig>

A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.

If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.



23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 23417

class HyperParameterTuningResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :allocation_strategy,
  :instance_configs)
  SENSITIVE = []
  include Aws::Structure
end

#instance_countInteger

The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.

Returns:

  • (Integer)


23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 23417

class HyperParameterTuningResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :allocation_strategy,
  :instance_configs)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.

Returns:

  • (String)


23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 23417

class HyperParameterTuningResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :allocation_strategy,
  :instance_configs)
  SENSITIVE = []
  include Aws::Structure
end

#volume_kms_key_idString

A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.

KMS Key ID:

"1234abcd-12ab-34cd-56ef-1234567890ab"

Amazon Resource Name (ARN) of a KMS key:

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.

Returns:

  • (String)


23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 23417

class HyperParameterTuningResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :allocation_strategy,
  :instance_configs)
  SENSITIVE = []
  include Aws::Structure
end

#volume_size_in_gbInteger

The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.

Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.

SageMaker supports only the General Purpose SSD (gp2) storage volume type.

Returns:

  • (Integer)


23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 23417

class HyperParameterTuningResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :allocation_strategy,
  :instance_configs)
  SENSITIVE = []
  include Aws::Structure
end