List Training Jobs For Hyper Parameter Tuning Job
sagemaker_list_training_jobs_for_hyper_parameter_tuning_job | R Documentation |
Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched¶
Description¶
Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
Usage¶
sagemaker_list_training_jobs_for_hyper_parameter_tuning_job(
HyperParameterTuningJobName, NextToken, MaxResults, StatusEquals,
SortBy, SortOrder)
Arguments¶
HyperParameterTuningJobName
[required] The name of the tuning job whose training jobs you want to list.
NextToken
If the result of the previous
list_training_jobs_for_hyper_parameter_tuning_job
request was truncated, the response includes aNextToken
. To retrieve the next set of training jobs, use the token in the next request.MaxResults
The maximum number of training jobs to return. The default value is 10.
StatusEquals
A filter that returns only training jobs with the specified status.
SortBy
The field to sort results by. The default is
Name
.If the value of this field is
FinalObjectiveMetricValue
, any training jobs that did not return an objective metric are not listed.SortOrder
The sort order for results. The default is
Ascending
.
Value¶
A list with the following syntax:
list(
TrainingJobSummaries = list(
list(
TrainingJobDefinitionName = "string",
TrainingJobName = "string",
TrainingJobArn = "string",
TuningJobName = "string",
CreationTime = as.POSIXct(
"2015-01-01"
),
TrainingStartTime = as.POSIXct(
"2015-01-01"
),
TrainingEndTime = as.POSIXct(
"2015-01-01"
),
TrainingJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped",
TunedHyperParameters = list(
"string"
),
FailureReason = "string",
FinalHyperParameterTuningJobObjectiveMetric = list(
Type = "Maximize"|"Minimize",
MetricName = "string",
Value = 123.0
),
ObjectiveStatus = "Succeeded"|"Pending"|"Failed"
)
),
NextToken = "string"
)
Request syntax¶
svc$list_training_jobs_for_hyper_parameter_tuning_job(
HyperParameterTuningJobName = "string",
NextToken = "string",
MaxResults = 123,
StatusEquals = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped",
SortBy = "Name"|"CreationTime"|"Status"|"FinalObjectiveMetricValue",
SortOrder = "Ascending"|"Descending"
)