AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DescribeHyperParameterTuningJobOutput

import "github.com/aws/aws-sdk-go/service/sagemaker"

type DescribeHyperParameterTuningJobOutput struct { BestTrainingJob *HyperParameterTrainingJobSummary `type:"structure"` CreationTime *time.Time `type:"timestamp" required:"true"` FailureReason *string `type:"string"` HyperParameterTuningEndTime *time.Time `type:"timestamp"` HyperParameterTuningJobArn *string `type:"string" required:"true"` HyperParameterTuningJobConfig *HyperParameterTuningJobConfig `type:"structure" required:"true"` HyperParameterTuningJobName *string `min:"1" type:"string" required:"true"` HyperParameterTuningJobStatus *string `type:"string" required:"true" enum:"HyperParameterTuningJobStatus"` LastModifiedTime *time.Time `type:"timestamp"` ObjectiveStatusCounters *ObjectiveStatusCounters `type:"structure" required:"true"` OverallBestTrainingJob *HyperParameterTrainingJobSummary `type:"structure"` TrainingJobDefinition *HyperParameterTrainingJobDefinition `type:"structure" required:"true"` TrainingJobStatusCounters *TrainingJobStatusCounters `type:"structure" required:"true"` WarmStartConfig *HyperParameterTuningJobWarmStartConfig `type:"structure"` }

BestTrainingJob

Specifies summary information about a training job.

CreationTime

Type: *time.Time

The date and time that the tuning job started.

CreationTime is a required field

FailureReason

Type: *string

If the tuning job failed, the reason it failed.

HyperParameterTuningEndTime

Type: *time.Time

The date and time that the tuning job ended.

HyperParameterTuningJobArn

Type: *string

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

HyperParameterTuningJobArn is a required field

HyperParameterTuningJobConfig

Configures a hyperparameter tuning job.

HyperParameterTuningJobName

Type: *string

The name of the tuning job.

HyperParameterTuningJobName is a required field

HyperParameterTuningJobStatus

Type: *string

The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

HyperParameterTuningJobStatus is a required field

LastModifiedTime

Type: *time.Time

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

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.

OverallBestTrainingJob

Specifies summary information about a training job.

TrainingJobDefinition

Defines the training jobs launched by a hyperparameter tuning job.

TrainingJobStatusCounters

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

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.

Method

GoString

func (s DescribeHyperParameterTuningJobOutput) GoString() string

GoString returns the string representation

SetBestTrainingJob

func (s *DescribeHyperParameterTuningJobOutput) SetBestTrainingJob(v *HyperParameterTrainingJobSummary) *DescribeHyperParameterTuningJobOutput

SetBestTrainingJob sets the BestTrainingJob field's value.

SetCreationTime

func (s *DescribeHyperParameterTuningJobOutput) SetCreationTime(v time.Time) *DescribeHyperParameterTuningJobOutput

SetCreationTime sets the CreationTime field's value.

SetFailureReason

func (s *DescribeHyperParameterTuningJobOutput) SetFailureReason(v string) *DescribeHyperParameterTuningJobOutput

SetFailureReason sets the FailureReason field's value.

SetHyperParameterTuningEndTime

func (s *DescribeHyperParameterTuningJobOutput) SetHyperParameterTuningEndTime(v time.Time) *DescribeHyperParameterTuningJobOutput

SetHyperParameterTuningEndTime sets the HyperParameterTuningEndTime field's value.

SetHyperParameterTuningJobArn

func (s *DescribeHyperParameterTuningJobOutput) SetHyperParameterTuningJobArn(v string) *DescribeHyperParameterTuningJobOutput

SetHyperParameterTuningJobArn sets the HyperParameterTuningJobArn field's value.

SetHyperParameterTuningJobConfig

func (s *DescribeHyperParameterTuningJobOutput) SetHyperParameterTuningJobConfig(v *HyperParameterTuningJobConfig) *DescribeHyperParameterTuningJobOutput

SetHyperParameterTuningJobConfig sets the HyperParameterTuningJobConfig field's value.

SetHyperParameterTuningJobName

func (s *DescribeHyperParameterTuningJobOutput) SetHyperParameterTuningJobName(v string) *DescribeHyperParameterTuningJobOutput

SetHyperParameterTuningJobName sets the HyperParameterTuningJobName field's value.

SetHyperParameterTuningJobStatus

func (s *DescribeHyperParameterTuningJobOutput) SetHyperParameterTuningJobStatus(v string) *DescribeHyperParameterTuningJobOutput

SetHyperParameterTuningJobStatus sets the HyperParameterTuningJobStatus field's value.

SetLastModifiedTime

func (s *DescribeHyperParameterTuningJobOutput) SetLastModifiedTime(v time.Time) *DescribeHyperParameterTuningJobOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

SetObjectiveStatusCounters

func (s *DescribeHyperParameterTuningJobOutput) SetObjectiveStatusCounters(v *ObjectiveStatusCounters) *DescribeHyperParameterTuningJobOutput

SetObjectiveStatusCounters sets the ObjectiveStatusCounters field's value.

SetOverallBestTrainingJob

func (s *DescribeHyperParameterTuningJobOutput) SetOverallBestTrainingJob(v *HyperParameterTrainingJobSummary) *DescribeHyperParameterTuningJobOutput

SetOverallBestTrainingJob sets the OverallBestTrainingJob field's value.

SetTrainingJobDefinition

func (s *DescribeHyperParameterTuningJobOutput) SetTrainingJobDefinition(v *HyperParameterTrainingJobDefinition) *DescribeHyperParameterTuningJobOutput

SetTrainingJobDefinition sets the TrainingJobDefinition field's value.

SetTrainingJobStatusCounters

func (s *DescribeHyperParameterTuningJobOutput) SetTrainingJobStatusCounters(v *TrainingJobStatusCounters) *DescribeHyperParameterTuningJobOutput

SetTrainingJobStatusCounters sets the TrainingJobStatusCounters field's value.

SetWarmStartConfig

func (s *DescribeHyperParameterTuningJobOutput) SetWarmStartConfig(v *HyperParameterTuningJobWarmStartConfig) *DescribeHyperParameterTuningJobOutput

SetWarmStartConfig sets the WarmStartConfig field's value.

String

func (s DescribeHyperParameterTuningJobOutput) String() string

String returns the string representation

On this page: