class Aws::SageMaker::Types::HyperParameterSpecification

Defines a hyperparameter to be used by an algorithm.

@note When making an API call, you may pass HyperParameterSpecification

data as a hash:

    {
      name: "ParameterName", # required
      description: "EntityDescription",
      type: "Integer", # required, accepts Integer, Continuous, Categorical, FreeText
      range: {
        integer_parameter_range_specification: {
          min_value: "ParameterValue", # required
          max_value: "ParameterValue", # required
        },
        continuous_parameter_range_specification: {
          min_value: "ParameterValue", # required
          max_value: "ParameterValue", # required
        },
        categorical_parameter_range_specification: {
          values: ["ParameterValue"], # required
        },
      },
      is_tunable: false,
      is_required: false,
      default_value: "HyperParameterValue",
    }

@!attribute [rw] name

The name of this hyperparameter. The name must be unique.
@return [String]

@!attribute [rw] description

A brief description of the hyperparameter.
@return [String]

@!attribute [rw] type

The type of this hyperparameter. The valid types are `Integer`,
`Continuous`, `Categorical`, and `FreeText`.
@return [String]

@!attribute [rw] range

The allowed range for this hyperparameter.
@return [Types::ParameterRange]

@!attribute [rw] is_tunable

Indicates whether this hyperparameter is tunable in a hyperparameter
tuning job.
@return [Boolean]

@!attribute [rw] is_required

Indicates whether this hyperparameter is required.
@return [Boolean]

@!attribute [rw] default_value

The default value for this hyperparameter. If a default value is
specified, a hyperparameter cannot be required.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/HyperParameterSpecification AWS API Documentation

Constants

SENSITIVE