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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/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.

Instance Attribute Summary collapse

Instance Attribute Details

#default_valueString

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

Returns:

  • (String)


5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5922

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

#descriptionString

A brief description of the hyperparameter.

Returns:

  • (String)


5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5922

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

#is_requiredBoolean

Indicates whether this hyperparameter is required.

Returns:

  • (Boolean)


5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5922

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

#is_tunableBoolean

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

Returns:

  • (Boolean)


5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5922

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

#nameString

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

Returns:

  • (String)


5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5922

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

#rangeTypes::ParameterRange

The allowed range for this hyperparameter.



5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5922

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

#typeString

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

Returns:

  • (String)


5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5922

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