Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: CC-BY-SA-4.0

Defines a hyperparameter to be used by an algorithm.

DefaultValue The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
Type: String
Length Constraints: Maximum length of 256.
Pattern: .*
Required: No

Description A brief description of the hyperparameter.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: [\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*
Required: No

IsRequired Indicates whether this hyperparameter is required.
Type: Boolean
Required: No

IsTunable Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
Type: Boolean
Required: No

Name The name of this hyperparameter. The name must be unique.
Type: String
Length Constraints: Maximum length of 256.
Pattern: [\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*
Required: Yes

Range The allowed range for this hyperparameter.
Type: ParameterRange object
Required: No

Type The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.
Type: String
Valid Values:Integer | Continuous | Categorical | FreeText
Required: Yes

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for Ruby V2