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.

HyperParameterTrainingJobSummary

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

type HyperParameterTrainingJobSummary struct { CreationTime *time.Time `type:"timestamp" required:"true"` FailureReason *string `type:"string"` FinalHyperParameterTuningJobObjectiveMetric *FinalHyperParameterTuningJobObjectiveMetric `type:"structure"` ObjectiveStatus *string `type:"string" enum:"ObjectiveStatus"` TrainingEndTime *time.Time `type:"timestamp"` TrainingJobArn *string `type:"string" required:"true"` TrainingJobName *string `min:"1" type:"string" required:"true"` TrainingJobStatus *string `type:"string" required:"true" enum:"TrainingJobStatus"` TrainingStartTime *time.Time `type:"timestamp"` TunedHyperParameters map[string]*string `type:"map" required:"true"` TuningJobName *string `min:"1" type:"string"` }

Specifies summary information about a training job.

CreationTime

Type: *time.Time

The date and time that the training job was created.

CreationTime is a required field

FailureReason

Type: *string

The reason that the training job failed.

FinalHyperParameterTuningJobObjectiveMetric

Shows the final value for the objective metric for a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

ObjectiveStatus

Type: *string

The status of the objective metric for the training job:

  • Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

  • Pending: The training job is in progress and evaluation of its final objective metric is pending.

  • Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

TrainingEndTime

Type: *time.Time

Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

TrainingJobArn

Type: *string

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

TrainingJobArn is a required field

TrainingJobName

Type: *string

The name of the training job.

TrainingJobName is a required field

TrainingJobStatus

Type: *string

The status of the training job.

TrainingJobStatus is a required field

TrainingStartTime

Type: *time.Time

The date and time that the training job started.

TunedHyperParameters

Type: map[string]*string

A list of the hyperparameters for which you specified ranges to search.

TunedHyperParameters is a required field

TuningJobName

Type: *string

The HyperParameter tuning job that launched the training job.

Method

GoString

func (s HyperParameterTrainingJobSummary) GoString() string

GoString returns the string representation

SetCreationTime

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

SetCreationTime sets the CreationTime field's value.

SetFailureReason

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

SetFailureReason sets the FailureReason field's value.

SetFinalHyperParameterTuningJobObjectiveMetric

func (s *HyperParameterTrainingJobSummary) SetFinalHyperParameterTuningJobObjectiveMetric(v *FinalHyperParameterTuningJobObjectiveMetric) *HyperParameterTrainingJobSummary

SetFinalHyperParameterTuningJobObjectiveMetric sets the FinalHyperParameterTuningJobObjectiveMetric field's value.

SetObjectiveStatus

func (s *HyperParameterTrainingJobSummary) SetObjectiveStatus(v string) *HyperParameterTrainingJobSummary

SetObjectiveStatus sets the ObjectiveStatus field's value.

SetTrainingEndTime

func (s *HyperParameterTrainingJobSummary) SetTrainingEndTime(v time.Time) *HyperParameterTrainingJobSummary

SetTrainingEndTime sets the TrainingEndTime field's value.

SetTrainingJobArn

func (s *HyperParameterTrainingJobSummary) SetTrainingJobArn(v string) *HyperParameterTrainingJobSummary

SetTrainingJobArn sets the TrainingJobArn field's value.

SetTrainingJobName

func (s *HyperParameterTrainingJobSummary) SetTrainingJobName(v string) *HyperParameterTrainingJobSummary

SetTrainingJobName sets the TrainingJobName field's value.

SetTrainingJobStatus

func (s *HyperParameterTrainingJobSummary) SetTrainingJobStatus(v string) *HyperParameterTrainingJobSummary

SetTrainingJobStatus sets the TrainingJobStatus field's value.

SetTrainingStartTime

func (s *HyperParameterTrainingJobSummary) SetTrainingStartTime(v time.Time) *HyperParameterTrainingJobSummary

SetTrainingStartTime sets the TrainingStartTime field's value.

SetTunedHyperParameters

func (s *HyperParameterTrainingJobSummary) SetTunedHyperParameters(v map[string]*string) *HyperParameterTrainingJobSummary

SetTunedHyperParameters sets the TunedHyperParameters field's value.

SetTuningJobName

func (s *HyperParameterTrainingJobSummary) SetTuningJobName(v string) *HyperParameterTrainingJobSummary

SetTuningJobName sets the TuningJobName field's value.

String

func (s HyperParameterTrainingJobSummary) String() string

String returns the string representation

On this page: