Skip to content

/AWS1/CL_SGMHYPPRMTUNJOBSRCH00

An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_hyperparamtuningjobname TYPE /AWS1/SGMHYPERPARAMTUNJOBNAME /AWS1/SGMHYPERPARAMTUNJOBNAME

The name of a hyperparameter tuning job.

iv_hyperparamtuningjobarn TYPE /AWS1/SGMHYPERPARAMTUNJOBARN /AWS1/SGMHYPERPARAMTUNJOBARN

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

io_hyperparamtuningjobconfig TYPE REF TO /AWS1/CL_SGMHYPPARAMTUNJOBCFG /AWS1/CL_SGMHYPPARAMTUNJOBCFG

Configures a hyperparameter tuning job.

io_trainingjobdefinition TYPE REF TO /AWS1/CL_SGMHYPPARAMTRNJOBDEFN /AWS1/CL_SGMHYPPARAMTRNJOBDEFN

Defines the training jobs launched by a hyperparameter tuning job.

it_trainingjobdefinitions TYPE /AWS1/CL_SGMHYPPARAMTRNJOBDEFN=>TT_HYPERPARAMTRAININGJOBDEFNS TT_HYPERPARAMTRAININGJOBDEFNS

The job definitions included in a hyperparameter tuning job.

iv_hyperparamtuningjobstatus TYPE /AWS1/SGMHYPERPARAMTUNJOBSTAT /AWS1/SGMHYPERPARAMTUNJOBSTAT

The status of a hyperparameter tuning job.

iv_creationtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

The time that a hyperparameter tuning job was created.

iv_hyperparamtuningendtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

The time that a hyperparameter tuning job ended.

iv_lastmodifiedtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

The time that a hyperparameter tuning job was last modified.

io_trainingjobstatuscounters TYPE REF TO /AWS1/CL_SGMTRNJOBSTATCOUNTERS /AWS1/CL_SGMTRNJOBSTATCOUNTERS

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

io_objectivestatuscounters TYPE REF TO /AWS1/CL_SGMOBJIVESTATCOUNTERS /AWS1/CL_SGMOBJIVESTATCOUNTERS

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

io_besttrainingjob TYPE REF TO /AWS1/CL_SGMHYPPARAMTRNJOBSUMM /AWS1/CL_SGMHYPPARAMTRNJOBSUMM

The container for the summary information about a training job.

io_overallbesttrainingjob TYPE REF TO /AWS1/CL_SGMHYPPARAMTRNJOBSUMM /AWS1/CL_SGMHYPPARAMTRNJOBSUMM

The container for the summary information about a training job.

io_warmstartconfig TYPE REF TO /AWS1/CL_SGMHYPPRMTUNJOBWARM00 /AWS1/CL_SGMHYPPRMTUNJOBWARM00

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

iv_failurereason TYPE /AWS1/SGMFAILUREREASON /AWS1/SGMFAILUREREASON

The error that was created when a hyperparameter tuning job failed.

io_tuningjobcompletiondets TYPE REF TO /AWS1/CL_SGMHYPPRMTUNJOBCOMP00 /AWS1/CL_SGMHYPPRMTUNJOBCOMP00

Information about either a current or completed hyperparameter tuning job.

io_consumedresources TYPE REF TO /AWS1/CL_SGMHYPPRMTUNJOBCONS00 /AWS1/CL_SGMHYPPRMTUNJOBCONS00

The total amount of resources consumed by a hyperparameter tuning job.

it_tags TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST TT_TAGLIST

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.


Queryable Attributes

HyperParameterTuningJobName

The name of a hyperparameter tuning job.

Accessible with the following methods

Method Description
GET_HYPERPARAMTUNINGJOBNAME() Getter for HYPERPARAMETERTUNINGJOBNAME, with configurable de
ASK_HYPERPARAMTUNINGJOBNAME() Getter for HYPERPARAMETERTUNINGJOBNAME w/ exceptions if fiel
HAS_HYPERPARAMTUNINGJOBNAME() Determine if HYPERPARAMETERTUNINGJOBNAME has a value

HyperParameterTuningJobArn

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

Accessible with the following methods

Method Description
GET_HYPERPARAMTUNINGJOBARN() Getter for HYPERPARAMETERTUNINGJOBARN, with configurable def
ASK_HYPERPARAMTUNINGJOBARN() Getter for HYPERPARAMETERTUNINGJOBARN w/ exceptions if field
HAS_HYPERPARAMTUNINGJOBARN() Determine if HYPERPARAMETERTUNINGJOBARN has a value

HyperParameterTuningJobConfig

Configures a hyperparameter tuning job.

Accessible with the following methods

Method Description
GET_HYPERPARAMTUNJOBCONFIG() Getter for HYPERPARAMTUNINGJOBCONFIG

TrainingJobDefinition

Defines the training jobs launched by a hyperparameter tuning job.

Accessible with the following methods

Method Description
GET_TRAININGJOBDEFINITION() Getter for TRAININGJOBDEFINITION

TrainingJobDefinitions

The job definitions included in a hyperparameter tuning job.

Accessible with the following methods

Method Description
GET_TRAININGJOBDEFINITIONS() Getter for TRAININGJOBDEFINITIONS, with configurable default
ASK_TRAININGJOBDEFINITIONS() Getter for TRAININGJOBDEFINITIONS w/ exceptions if field has
HAS_TRAININGJOBDEFINITIONS() Determine if TRAININGJOBDEFINITIONS has a value

HyperParameterTuningJobStatus

The status of a hyperparameter tuning job.

Accessible with the following methods

Method Description
GET_HYPERPARAMTUNJOBSTATUS() Getter for HYPERPARAMTUNINGJOBSTATUS, with configurable defa
ASK_HYPERPARAMTUNJOBSTATUS() Getter for HYPERPARAMTUNINGJOBSTATUS w/ exceptions if field
HAS_HYPERPARAMTUNJOBSTATUS() Determine if HYPERPARAMTUNINGJOBSTATUS has a value

CreationTime

The time that a hyperparameter tuning job was created.

Accessible with the following methods

Method Description
GET_CREATIONTIME() Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME() Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME() Determine if CREATIONTIME has a value

HyperParameterTuningEndTime

The time that a hyperparameter tuning job ended.

Accessible with the following methods

Method Description
GET_HYPERPARAMTUNINGENDTIME() Getter for HYPERPARAMETERTUNINGENDTIME, with configurable de
ASK_HYPERPARAMTUNINGENDTIME() Getter for HYPERPARAMETERTUNINGENDTIME w/ exceptions if fiel
HAS_HYPERPARAMTUNINGENDTIME() Determine if HYPERPARAMETERTUNINGENDTIME has a value

LastModifiedTime

The time that a hyperparameter tuning job was last modified.

Accessible with the following methods

Method Description
GET_LASTMODIFIEDTIME() Getter for LASTMODIFIEDTIME, with configurable default
ASK_LASTMODIFIEDTIME() Getter for LASTMODIFIEDTIME w/ exceptions if field has no va
HAS_LASTMODIFIEDTIME() Determine if LASTMODIFIEDTIME has a value

TrainingJobStatusCounters

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

Accessible with the following methods

Method Description
GET_TRNJOBSTATUSCOUNTERS() Getter for TRAININGJOBSTATUSCOUNTERS

ObjectiveStatusCounters

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

Accessible with the following methods

Method Description
GET_OBJECTIVESTATUSCOUNTERS() Getter for OBJECTIVESTATUSCOUNTERS

BestTrainingJob

The container for the summary information about a training job.

Accessible with the following methods

Method Description
GET_BESTTRAININGJOB() Getter for BESTTRAININGJOB

OverallBestTrainingJob

The container for the summary information about a training job.

Accessible with the following methods

Method Description
GET_OVERALLBESTTRAININGJOB() Getter for OVERALLBESTTRAININGJOB

WarmStartConfig

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

Accessible with the following methods

Method Description
GET_WARMSTARTCONFIG() Getter for WARMSTARTCONFIG

FailureReason

The error that was created when a hyperparameter tuning job failed.

Accessible with the following methods

Method Description
GET_FAILUREREASON() Getter for FAILUREREASON, with configurable default
ASK_FAILUREREASON() Getter for FAILUREREASON w/ exceptions if field has no value
HAS_FAILUREREASON() Determine if FAILUREREASON has a value

TuningJobCompletionDetails

Information about either a current or completed hyperparameter tuning job.

Accessible with the following methods

Method Description
GET_TUNINGJOBCOMPLETIONDETS() Getter for TUNINGJOBCOMPLETIONDETAILS

ConsumedResources

The total amount of resources consumed by a hyperparameter tuning job.

Accessible with the following methods

Method Description
GET_CONSUMEDRESOURCES() Getter for CONSUMEDRESOURCES

Tags

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

Accessible with the following methods

Method Description
GET_TAGS() Getter for TAGS, with configurable default
ASK_TAGS() Getter for TAGS w/ exceptions if field has no value
HAS_TAGS() Determine if TAGS has a value