Class: Aws::SageMaker::Types::AlgorithmSpecification

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::AlgorithmSpecification

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

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

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

Specifies the training algorithm to use in a CreateTrainingJob request.

For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #algorithm_name ⇒ String

  The name of the algorithm resource to use for the training job.

• #enable_sage_maker_metrics_time_series ⇒ Boolean

  To generate and save time-series metrics during training, set to true.

• #metric_definitions ⇒ Array<Types::MetricDefinition>

  A list of metric definition objects.

• #training_image ⇒ String

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

• #training_input_mode ⇒ String

  The input mode that the algorithm supports.

Instance Attribute Details

#algorithm_name ⇒ String

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

Returns:

• (String)

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

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

#enable_sage_maker_metrics_time_series ⇒ Boolean

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

• You use one of the Amazon SageMaker built-in algorithms

• You use one of the following Prebuilt Amazon SageMaker Docker Images:

  • Tensorflow (version >= 1.15)

  • MXNet (version >= 1.6)

  • PyTorch (version >= 1.3)

• You specify at least one MetricDefinition

Returns:

• (Boolean)

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

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

#metric_definitions ⇒ Array<Types::MetricDefinition>

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Returns:

• (Array<Types::MetricDefinition>)

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

class AlgorithmSpecification < Struct.new(
  :training_image,
  :algorithm_name,
  :training_input_mode,
  :metric_definitions,
  :enable_sage_maker_metrics_time_series)
  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. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Returns:

• (String)

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

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

#training_input_mode ⇒ String

The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any.

For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon 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 where one host in a training cluster is overloaded, thus becoming bottleneck in training.

Returns:

• (String)

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

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