Class: Aws::SageMaker::Types::HyperParameterAlgorithmSpecification

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::HyperParameterAlgorithmSpecification

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #algorithm_name ⇒ String

  The name of the resource algorithm to use for the hyperparameter tuning job.

• #metric_definitions ⇒ Array<Types::MetricDefinition>

  An array of [MetricDefinition] objects that specify the metrics that the algorithm emits.

• #training_image ⇒ String

  The registry path of the Docker image that contains the training algorithm.

• #training_input_mode ⇒ String

  The training input mode that the algorithm supports.

Instance Attribute Details

#algorithm_name ⇒ String

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for ‘TrainingImage`.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 22832

class HyperParameterAlgorithmSpecification < Struct.new(
  :training_image,
  :training_input_mode,
  :algorithm_name,
  :metric_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#metric_definitions ⇒ Array<Types::MetricDefinition>

An array of [MetricDefinition] objects that specify the metrics that the algorithm emits.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html

Returns:

• (Array<Types::MetricDefinition>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 22832

class HyperParameterAlgorithmSpecification < Struct.new(
  :training_image,
  :training_input_mode,
  :algorithm_name,
  :metric_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#training_image ⇒ String

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see [Algorithms Provided by Amazon SageMaker: Common Parameters]. SageMaker supports both ‘registry/repository` and `registry/repository` image path formats. For more information, see [Using Your Own Algorithms with Amazon SageMaker].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html [2]: docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 22832

class HyperParameterAlgorithmSpecification < Struct.new(
  :training_image,
  :training_input_mode,
  :algorithm_name,
  :metric_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#training_input_mode ⇒ String

The training input mode that the algorithm supports. For more information about input modes, see [Algorithms].

**Pipe mode**

If an algorithm supports ‘Pipe` mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

**File mode**

If an algorithm supports ‘File` mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won’t be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

**FastFile mode**

If an algorithm supports ‘FastFile` mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

‘FastFile` mode works best when the data is read sequentially. Augmented manifest files aren’t supported. The startup time is lower when there are fewer files in the S3 bucket provided.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/algos.html

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 22832

class HyperParameterAlgorithmSpecification < Struct.new(
  :training_image,
  :training_input_mode,
  :algorithm_name,
  :metric_definitions)
  SENSITIVE = []
  include Aws::Structure
end