/AWS1/CL_SGMHYPERPARAMETERSPEC

Defines a hyperparameter to be used by an algorithm.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/SGMPARAMETERNAME /AWS1/SGMPARAMETERNAME

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

iv_type TYPE /AWS1/SGMPARAMETERTYPE /AWS1/SGMPARAMETERTYPE

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

Optional arguments:

iv_description TYPE /AWS1/SGMENTITYDESCRIPTION /AWS1/SGMENTITYDESCRIPTION

A brief description of the hyperparameter.

io_range TYPE REF TO /AWS1/CL_SGMPARAMETERRANGE /AWS1/CL_SGMPARAMETERRANGE

The allowed range for this hyperparameter.

iv_istunable TYPE /AWS1/SGMBOOLEAN /AWS1/SGMBOOLEAN

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

iv_isrequired TYPE /AWS1/SGMBOOLEAN /AWS1/SGMBOOLEAN

Indicates whether this hyperparameter is required.

iv_defaultvalue TYPE /AWS1/SGMHYPERPARAMETERVALUE /AWS1/SGMHYPERPARAMETERVALUE

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

---

Queryable Attributes

Name

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

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

Description

A brief description of the hyperparameter.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

Type

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

Accessible with the following methods

Method	Description
GET_TYPE()	Getter for TYPE, with configurable default
ASK_TYPE()	Getter for TYPE w/ exceptions if field has no value
HAS_TYPE()	Determine if TYPE has a value

Range

The allowed range for this hyperparameter.

Accessible with the following methods

Method	Description
GET_RANGE()	Getter for RANGE

IsTunable

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

Accessible with the following methods

Method	Description
GET_ISTUNABLE()	Getter for ISTUNABLE, with configurable default
ASK_ISTUNABLE()	Getter for ISTUNABLE w/ exceptions if field has no value
HAS_ISTUNABLE()	Determine if ISTUNABLE has a value

IsRequired

Indicates whether this hyperparameter is required.

Accessible with the following methods

Method	Description
GET_ISREQUIRED()	Getter for ISREQUIRED, with configurable default
ASK_ISREQUIRED()	Getter for ISREQUIRED w/ exceptions if field has no value
HAS_ISREQUIRED()	Determine if ISREQUIRED has a value

DefaultValue

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

Accessible with the following methods

Method	Description
GET_DEFAULTVALUE()	Getter for DEFAULTVALUE, with configurable default
ASK_DEFAULTVALUE()	Getter for DEFAULTVALUE w/ exceptions if field has no value
HAS_DEFAULTVALUE()	Determine if DEFAULTVALUE has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_HYPERPARAMETERSPECS

TYPES TT_HYPERPARAMETERSPECS TYPE STANDARD TABLE OF REF TO /AWS1/CL_SGMHYPERPARAMETERSPEC WITH DEFAULT KEY
.