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

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

Overview

The configuration of resources, including compute instances and storage volumes for use in training jobs launched by hyperparameter tuning jobs. ‘HyperParameterTuningResourceConfig` is similar to `ResourceConfig`, but has the additional `InstanceConfigs` and `AllocationStrategy` fields to allow for flexible instance management. Specify one or more instance types, count, and the allocation strategy for instance selection.

<note markdown=“1”> ‘HyperParameterTuningResourceConfig` supports the capabilities of `ResourceConfig` with the exception of `KeepAlivePeriodInSeconds`. Hyperparameter tuning jobs use warm pools by default, which reuse clusters between training jobs.

</note>

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocation_strategy ⇒ String

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

Returns:

  • (String) 


22487
22488
22489
22490
22491
22492
22493
22494
22495
22496
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 22487

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_configs ⇒ Array<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.

<note markdown=“1”> 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`.

</note>

Returns:



22487
22488
22489
22490
22491
22492
22493
22494
22495
22496
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 22487

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_count ⇒ Integer

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

[1]: docs.aws.amazon.com/sagemaker/latest/dg/data-parallel-use-api.html

Returns:

  • (Integer) 


22487
22488
22489
22490
22491
22492
22493
22494
22495
22496
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 22487

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_type ⇒ String

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

[1]: docs.aws.amazon.com/sagemaker/latest/dg/notebooks-available-instance-types.html

Returns:

  • (String) 


22487
22488
22489
22490
22491
22492
22493
22494
22495
22496
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 22487

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_id ⇒ String

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html [2]: aws.amazon.com/releasenotes/host-instance-storage-volumes-table/ [3]: docs.aws.amazon.com/sagemaker/latest/dg/sms-security-kms-permissions.html

Returns:

  • (String) 


22487
22488
22489
22490
22491
22492
22493
22494
22495
22496
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 22487

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_gb ⇒ Integer

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

<note markdown=“1”> SageMaker supports only the [General Purpose SSD (gp2)] storage volume type.

</note>

[1]: aws.amazon.com/releasenotes/host-instance-storage-volumes-table/ [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html

Returns:

  • (Integer) 


22487
22488
22489
22490
22491
22492
22493
22494
22495
22496
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 22487

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