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

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

Overview

Defines a hyperparameter to be used by an algorithm.

Constant Summary collapse

SENSITIVE =
[]

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)


21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 21553

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

#descriptionString

A brief description of the hyperparameter.

Returns:

  • (String)


21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 21553

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

#is_requiredBoolean

Indicates whether this hyperparameter is required.

Returns:

  • (Boolean)


21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 21553

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

#is_tunableBoolean

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

Returns:

  • (Boolean)


21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 21553

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

#nameString

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

Returns:

  • (String)


21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 21553

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

#rangeTypes::ParameterRange

The allowed range for this hyperparameter.



21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 21553

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

#typeString

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

Returns:

  • (String)


21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 21553

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