Class: Aws::SageMaker::Types::ResourceConfig

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

Overview

Describes the resources, including machine learning (ML) compute instances and ML storage volumes, to use for model training.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#instance_count ⇒ Integer

The number of ML compute instances to use. For distributed training, provide a value greater than 1.

Returns:

  • (Integer) 


41297
41298
41299
41300
41301
41302
41303
41304
41305
41306
41307
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 41297

class ResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :keep_alive_period_in_seconds,
  :instance_groups,
  :training_plan_arn)
  SENSITIVE = []
  include Aws::Structure
end

#instance_groups ⇒ Array<Types::InstanceGroup>

The configuration of a heterogeneous cluster in JSON format.

Returns:



41297
41298
41299
41300
41301
41302
41303
41304
41305
41306
41307
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 41297

class ResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :keep_alive_period_in_seconds,
  :instance_groups,
  :training_plan_arn)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ String

The ML compute instance type.

<note markdown=“1”> SageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting December 9th, 2022.

[Amazon EC2 P4de instances][1] (currently in preview) are powered by

8 NVIDIA A100 GPUs with 80GB high-performance HBM2e GPU memory, which accelerate the speed of training ML models that need to be trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker supports ML training jobs on P4de instances (‘ml.p4de.24xlarge`) to reduce model training time. The `ml.p4de.24xlarge` instances are available in the following Amazon Web Services Regions.

* US East (N. Virginia) (us-east-1)

  • US West (Oregon) (us-west-2)

To request quota limit increase and start using P4de instances,

contact the SageMaker Training service team through your account team.

</note>

[1]: aws.amazon.com/ec2/instance-types/p4/

Returns:

  • (String) 


41297
41298
41299
41300
41301
41302
41303
41304
41305
41306
41307
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 41297

class ResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :keep_alive_period_in_seconds,
  :instance_groups,
  :training_plan_arn)
  SENSITIVE = []
  include Aws::Structure
end

#keep_alive_period_in_seconds ⇒ Integer

The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.

Returns:

  • (Integer) 


41297
41298
41299
41300
41301
41302
41303
41304
41305
41306
41307
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 41297

class ResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :keep_alive_period_in_seconds,
  :instance_groups,
  :training_plan_arn)
  SENSITIVE = []
  include Aws::Structure
end

#training_plan_arn ⇒ String

The Amazon Resource Name (ARN); of the training plan to use for this resource configuration.

Returns:

  • (String) 


41297
41298
41299
41300
41301
41302
41303
41304
41305
41306
41307
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 41297

class ResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :keep_alive_period_in_seconds,
  :instance_groups,
  :training_plan_arn)
  SENSITIVE = []
  include Aws::Structure
end

#volume_kms_key_id ⇒ String

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.

<note markdown=“1”> Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can’t request a ‘VolumeKmsKeyId` when using an instance type with local storage.

For a list of instance types that support local instance storage,

see [Instance Store Volumes].

For more information about local instance storage encryption, see

[SSD Instance Store Volumes].

</note>

The ‘VolumeKmsKeyId` can be in any of the following formats:

  • // 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”`

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html

Returns:

  • (String) 


41297
41298
41299
41300
41301
41302
41303
41304
41305
41306
41307
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 41297

class ResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :keep_alive_period_in_seconds,
  :instance_groups,
  :training_plan_arn)
  SENSITIVE = []
  include Aws::Structure
end

#volume_size_in_gb ⇒ Integer

The size of the ML storage volume that you want to provision.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose ‘File` as the `TrainingInputMode` in the algorithm specification.

When using an ML instance with [NVMe SSD volumes], SageMaker doesn’t provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is fixed to the NVMe-type instance’s storage capacity. SageMaker configures storage paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML instance families with the NVMe-type instance storage include ‘ml.p4d`, `ml.g4dn`, and `ml.g5`.

When using an ML instance with the EBS-only storage option and without instance storage, you must define the size of EBS volume through ‘VolumeSizeInGB` in the `ResourceConfig` API. For example, ML instance families that use EBS volumes include `ml.c5` and `ml.p2`.

To look up instance types and their instance storage types and volumes, see [Amazon EC2 Instance Types].

To find the default local paths defined by the SageMaker training platform, see [Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html#nvme-ssd-volumes [2]: aws.amazon.com/ec2/instance-types/ [3]: docs.aws.amazon.com/sagemaker/latest/dg/model-train-storage.html

Returns:

  • (Integer) 


41297
41298
41299
41300
41301
41302
41303
41304
41305
41306
41307
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 41297

class ResourceConfig < Struct.new(
  :instance_type,
  :instance_count,
  :volume_size_in_gb,
  :volume_kms_key_id,
  :keep_alive_period_in_seconds,
  :instance_groups,
  :training_plan_arn)
  SENSITIVE = []
  include Aws::Structure
end