You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SageMaker::Types::HyperParameterSpecification

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing HyperParameterSpecification as input to an Aws::Client method, you can use a vanilla 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",
}

Defines a hyperparameter to be used by an algorithm.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#default_value ⇒ String

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

Returns:

  • (String) —

    The default value for this hyperparameter.

#description ⇒ String

A brief description of the hyperparameter.

Returns:

  • (String) —

    A brief description of the hyperparameter.

#is_required ⇒ Boolean

Indicates whether this hyperparameter is required.

Returns:

  • (Boolean) —

    Indicates whether this hyperparameter is required.

#is_tunable ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#name ⇒ String

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

Returns:

  • (String) —

    The name of this hyperparameter.

#range ⇒ Types::ParameterRange

The allowed range for this hyperparameter.

Returns:

#type ⇒ String

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

Possible values:

  • Integer
  • Continuous
  • Categorical
  • FreeText

Returns:

  • (String) —

    The type of this hyperparameter.