1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package sagemaker
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/sagemaker/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Gets a description of a hyperparameter tuning job.
func (c *Client) DescribeHyperParameterTuningJob(ctx context.Context, params *DescribeHyperParameterTuningJobInput, optFns ...func(*Options)) (*DescribeHyperParameterTuningJobOutput, error) {
if params == nil {
params = &DescribeHyperParameterTuningJobInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeHyperParameterTuningJob", params, optFns, c.addOperationDescribeHyperParameterTuningJobMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeHyperParameterTuningJobOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeHyperParameterTuningJobInput struct {
// The name of the tuning job.
//
// This member is required.
HyperParameterTuningJobName *string
noSmithyDocumentSerde
}
type DescribeHyperParameterTuningJobOutput struct {
// The date and time that the tuning job started.
//
// This member is required.
CreationTime *time.Time
// The Amazon Resource Name (ARN) of the tuning job.
//
// This member is required.
HyperParameterTuningJobArn *string
// The HyperParameterTuningJobConfig object that specifies the configuration of the
// tuning job.
//
// This member is required.
HyperParameterTuningJobConfig *types.HyperParameterTuningJobConfig
// The name of the tuning job.
//
// This member is required.
HyperParameterTuningJobName *string
// The status of the tuning job: InProgress, Completed, Failed, Stopping, or
// Stopped.
//
// This member is required.
HyperParameterTuningJobStatus types.HyperParameterTuningJobStatus
// The ObjectiveStatusCounters object that specifies the number of training jobs,
// categorized by the status of their final objective metric, that this tuning job
// launched.
//
// This member is required.
ObjectiveStatusCounters *types.ObjectiveStatusCounters
// The TrainingJobStatusCounters object that specifies the number of training jobs,
// categorized by status, that this tuning job launched.
//
// This member is required.
TrainingJobStatusCounters *types.TrainingJobStatusCounters
// A TrainingJobSummary object that describes the training job that completed with
// the best current HyperParameterTuningJobObjective.
BestTrainingJob *types.HyperParameterTrainingJobSummary
// If the tuning job failed, the reason it failed.
FailureReason *string
// The date and time that the tuning job ended.
HyperParameterTuningEndTime *time.Time
// The date and time that the status of the tuning job was modified.
LastModifiedTime *time.Time
// 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.
OverallBestTrainingJob *types.HyperParameterTrainingJobSummary
// The HyperParameterTrainingJobDefinition object that specifies the definition of
// the training jobs that this tuning job launches.
TrainingJobDefinition *types.HyperParameterTrainingJobDefinition
// A list of the HyperParameterTrainingJobDefinition objects launched for this
// tuning job.
TrainingJobDefinitions []types.HyperParameterTrainingJobDefinition
// 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.
WarmStartConfig *types.HyperParameterTuningJobWarmStartConfig
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeHyperParameterTuningJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeHyperParameterTuningJob{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeHyperParameterTuningJob{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpDescribeHyperParameterTuningJobValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeHyperParameterTuningJob(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDescribeHyperParameterTuningJob(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "sagemaker",
OperationName: "DescribeHyperParameterTuningJob",
}
}
|
