AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the DescribeHyperParameterTuningJob operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.SageMaker.Model.DescribeHyperParameterTuningJobResponse

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C# 
public class DescribeHyperParameterTuningJobResponse : AmazonWebServiceResponse

The DescribeHyperParameterTuningJobResponse type exposes the following members

Constructors

NameDescription
Public Method DescribeHyperParameterTuningJobResponse()

Properties

NameTypeDescription
Public Property Autotune Amazon.SageMaker.Model.Autotune

Gets and sets the property Autotune.

A flag to indicate if autotune is enabled for the hyperparameter tuning job.

Public Property BestTrainingJob Amazon.SageMaker.Model.HyperParameterTrainingJobSummary

Gets and sets the property BestTrainingJob.

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

Public Property ConsumedResources Amazon.SageMaker.Model.HyperParameterTuningJobConsumedResources

Gets and sets the property ConsumedResources.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreationTime System.DateTime

Gets and sets the property CreationTime.

The date and time that the tuning job started.

Public Property FailureReason System.String

Gets and sets the property FailureReason.

If the tuning job failed, the reason it failed.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property HyperParameterTuningEndTime System.DateTime

Gets and sets the property HyperParameterTuningEndTime.

The date and time that the tuning job ended.

Public Property HyperParameterTuningJobArn System.String

Gets and sets the property HyperParameterTuningJobArn.

The Amazon Resource Name (ARN) of the tuning job.

Public Property HyperParameterTuningJobConfig Amazon.SageMaker.Model.HyperParameterTuningJobConfig

Gets and sets the property HyperParameterTuningJobConfig.

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

Public Property HyperParameterTuningJobName System.String

Gets and sets the property HyperParameterTuningJobName.

The name of the hyperparameter tuning job.

Public Property HyperParameterTuningJobStatus Amazon.SageMaker.HyperParameterTuningJobStatus

Gets and sets the property HyperParameterTuningJobStatus.

The status of the tuning job.

Public Property LastModifiedTime System.DateTime

Gets and sets the property LastModifiedTime.

The date and time that the status of the tuning job was modified.

Public Property ObjectiveStatusCounters Amazon.SageMaker.Model.ObjectiveStatusCounters

Gets and sets the property ObjectiveStatusCounters.

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

Public Property OverallBestTrainingJob Amazon.SageMaker.Model.HyperParameterTrainingJobSummary

Gets and sets the property OverallBestTrainingJob.

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property TrainingJobDefinition Amazon.SageMaker.Model.HyperParameterTrainingJobDefinition

Gets and sets the property TrainingJobDefinition.

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

Public Property TrainingJobDefinitions System.Collections.Generic.List<Amazon.SageMaker.Model.HyperParameterTrainingJobDefinition>

Gets and sets the property TrainingJobDefinitions.

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

Public Property TrainingJobStatusCounters Amazon.SageMaker.Model.TrainingJobStatusCounters

Gets and sets the property TrainingJobStatusCounters.

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

Public Property TuningJobCompletionDetails Amazon.SageMaker.Model.HyperParameterTuningJobCompletionDetails

Gets and sets the property TuningJobCompletionDetails.

Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.

Public Property WarmStartConfig Amazon.SageMaker.Model.HyperParameterTuningJobWarmStartConfig

Gets and sets the property WarmStartConfig.

The configuration for starting the hyperparameter parameter tuning job using one or more previous 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5