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

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::HyperParameterSpecification

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

Defines a hyperparameter to be used by an algorithm.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_value ⇒ String

  The default value for this hyperparameter.

• #description ⇒ String

  A brief description of the hyperparameter.

• #is_required ⇒ Boolean

  Indicates whether this hyperparameter is required.

• #is_tunable ⇒ Boolean

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

• #name ⇒ String

  The name of this hyperparameter.

• #range ⇒ Types::ParameterRange

  The allowed range for this hyperparameter.

• #type ⇒ String

  The type of this hyperparameter.

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)

# File 'lib/aws-sdk-sagemaker/types.rb', line 22837

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

#description ⇒ String

A brief description of the hyperparameter.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 22837

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

#is_required ⇒ Boolean

Indicates whether this hyperparameter is required.

Returns:

• (Boolean)

# File 'lib/aws-sdk-sagemaker/types.rb', line 22837

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

#is_tunable ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-sagemaker/types.rb', line 22837

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

#name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 22837

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

#range ⇒ Types::ParameterRange

The allowed range for this hyperparameter.

Returns:

• (Types::ParameterRange)

# File 'lib/aws-sdk-sagemaker/types.rb', line 22837

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

#type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 22837

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