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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sagemaker/types.rb

Overview

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: "ParameterValue",
}

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) 


10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 10295

class HyperParameterSpecification < Struct.new(
  :name,
  :description,
  :type,
  :range,
  :is_tunable,
  :is_required,
  :default_value)
  include Aws::Structure
end

#description ⇒ String

A brief description of the hyperparameter.

Returns:

  • (String) 


10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 10295

class HyperParameterSpecification < Struct.new(
  :name,
  :description,
  :type,
  :range,
  :is_tunable,
  :is_required,
  :default_value)
  include Aws::Structure
end

#is_required ⇒ Boolean

Indicates whether this hyperparameter is required.

Returns:

  • (Boolean) 


10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 10295

class HyperParameterSpecification < Struct.new(
  :name,
  :description,
  :type,
  :range,
  :is_tunable,
  :is_required,
  :default_value)
  include Aws::Structure
end

#is_tunable ⇒ Boolean

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

Returns:

  • (Boolean) 


10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 10295

class HyperParameterSpecification < Struct.new(
  :name,
  :description,
  :type,
  :range,
  :is_tunable,
  :is_required,
  :default_value)
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 


10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 10295

class HyperParameterSpecification < Struct.new(
  :name,
  :description,
  :type,
  :range,
  :is_tunable,
  :is_required,
  :default_value)
  include Aws::Structure
end

#range ⇒ Types::ParameterRange

The allowed range for this hyperparameter.

Returns:



10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 10295

class HyperParameterSpecification < Struct.new(
  :name,
  :description,
  :type,
  :range,
  :is_tunable,
  :is_required,
  :default_value)
  include Aws::Structure
end

#type ⇒ String

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

Returns:

  • (String) 


10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 10295

class HyperParameterSpecification < Struct.new(
  :name,
  :description,
  :type,
  :range,
  :is_tunable,
  :is_required,
  :default_value)
  include Aws::Structure
end