View a markdown version of this page

AWS::SageMaker::Algorithm HyperParameterSpecification - 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 HyperParameterSpecification

Defines a hyperparameter to be used by an algorithm.

Syntax

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

JSON

{
  "DefaultValue" : String,
  "Description" : String,
  "IsRequired" : Boolean,
  "IsTunable" : Boolean,
  "Name" : String,
  "Range" : ParameterRange,
  "Type" : String
}

YAML

  DefaultValue: String
  Description: String
  IsRequired: Boolean
  IsTunable: Boolean
  Name: String
  Range: 
    ParameterRange
  Type: String

Properties

DefaultValue

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

Required: No

Type: String

Maximum: 2500

Update requires: Replacement

Description

A brief description of the hyperparameter.

Required: No

Type: String

Maximum: 1024

Update requires: Replacement

IsRequired

Indicates whether this hyperparameter is required.

Required: No

Type: Boolean

Update requires: Replacement

IsTunable

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

Required: No

Type: Boolean

Update requires: Replacement

Name

The name of this hyperparameter. The name must be unique.

Required: Yes

Type: String

Maximum: 256

Update requires: Replacement

Range

The allowed range for this hyperparameter.

Required: No

Type: ParameterRange

Update requires: Replacement

Type

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

Required: Yes

Type: String

Allowed values: Integer | Continuous | Categorical | FreeText

Update requires: Replacement