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

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

Overview

Note:

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

{
  training_image: "AlgorithmImage",
  training_input_mode: "Pipe", # required, accepts Pipe, File
  algorithm_name: "ArnOrName",
  metric_definitions: [
    {
      name: "MetricName", # required
      regex: "MetricRegex", # required
    },
  ],
}

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

See Also:

Instance Attribute Summary collapse

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) 


10227
10228
10229
10230
10231
10232
10233
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 10227

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

#metric_definitions ⇒ Array<Types::MetricDefinition>

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

Returns:



10227
10228
10229
10230
10231
10232
10233
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 10227

class HyperParameterAlgorithmSpecification < Struct.new(
  :training_image,
  :training_input_mode,
  :algorithm_name,
  :metric_definitions)
  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]. Amazon 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) 


10227
10228
10229
10230
10231
10232
10233
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 10227

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

#training_input_mode ⇒ String

The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.

For more information about input modes, see [Algorithms].

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

Returns:

  • (String) 


10227
10228
10229
10230
10231
10232
10233
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 10227

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