View a markdown version of this page

AWS::SageMaker::Algorithm HyperParameterTuningJobObjective - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::SageMaker::Algorithm HyperParameterTuningJobObjective

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter. If you want to define a custom objective metric, see Define metrics and environment variables.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "MetricName" : String,
  "Type" : String
}

YAML

  MetricName: String
  Type: String

Properties

MetricName

The name of the metric to use for the objective metric.

Required: Yes

Type: String

Pattern: ^.+$

Minimum: 1

Maximum: 255

Update requires: Replacement

Type

Whether to minimize or maximize the objective metric.

Required: Yes

Type: String

Allowed values: Maximize | Minimize

Update requires: Replacement