Skip to content

Commit 2d197cb

Browse files
author
awstools
committed
feat(client-sagemaker): This release adds Mode to AutoMLJobConfig.
1 parent 9676c8f commit 2d197cb

File tree

9 files changed

+116
-41
lines changed

9 files changed

+116
-41
lines changed

clients/client-sagemaker/src/SageMaker.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3120,6 +3120,12 @@ export class SageMaker extends SageMakerClient {
31203120
* enable the estimation of model parameters during training. Hyperparameters can
31213121
* be tuned to optimize this learning process. For a list of hyperparameters for
31223122
* each training algorithm provided by SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. </p>
3123+
* <important>
3124+
* <p>You must not include any security-sensitive information, such as
3125+
* account access IDs, secrets, and tokens, in the dictionary for configuring
3126+
* hyperparameters. SageMaker rejects the training job request and returns an
3127+
* exception error for detected credentials, if such user input is found.</p>
3128+
* </important>
31233129
* </li>
31243130
* <li>
31253131
* <p>

clients/client-sagemaker/src/commands/CreateTrainingJobCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ export interface CreateTrainingJobCommandOutput extends CreateTrainingJobRespons
4949
* enable the estimation of model parameters during training. Hyperparameters can
5050
* be tuned to optimize this learning process. For a list of hyperparameters for
5151
* each training algorithm provided by SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. </p>
52+
* <important>
53+
* <p>You must not include any security-sensitive information, such as
54+
* account access IDs, secrets, and tokens, in the dictionary for configuring
55+
* hyperparameters. SageMaker rejects the training job request and returns an
56+
* exception error for detected credentials, if such user input is found.</p>
57+
* </important>
5258
* </li>
5359
* <li>
5460
* <p>

clients/client-sagemaker/src/commands/DescribeFlowDefinitionCommand.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,12 @@ import {
1212
SerdeContext as __SerdeContext,
1313
} from "@aws-sdk/types";
1414

15-
import { DescribeFlowDefinitionRequest, DescribeFlowDefinitionRequestFilterSensitiveLog } from "../models/models_1";
16-
import { DescribeFlowDefinitionResponse, DescribeFlowDefinitionResponseFilterSensitiveLog } from "../models/models_2";
15+
import {
16+
DescribeFlowDefinitionRequest,
17+
DescribeFlowDefinitionRequestFilterSensitiveLog,
18+
DescribeFlowDefinitionResponse,
19+
DescribeFlowDefinitionResponseFilterSensitiveLog,
20+
} from "../models/models_2";
1721
import {
1822
deserializeAws_json1_1DescribeFlowDefinitionCommand,
1923
serializeAws_json1_1DescribeFlowDefinitionCommand,

clients/client-sagemaker/src/models/models_0.ts

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4059,7 +4059,8 @@ export interface AutoMLS3DataSource {
40594059
* <p>The data type.</p>
40604060
* <p>A ManifestFile should have the format shown below:</p>
40614061
* <p>
4062-
* <code>[ {"prefix": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/"}, </code>
4062+
* <code>[ {"prefix": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/"},
4063+
* </code>
40634064
* </p>
40644065
* <p>
40654066
* <code>"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1",</code>
@@ -4178,8 +4179,9 @@ export interface AutoMLJobCompletionCriteria {
41784179
MaxCandidates?: number;
41794180

41804181
/**
4181-
* <p>The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a
4182-
* hyperparameter tuning job. For more information, see the used by the action.</p>
4182+
* <p>The maximum time, in seconds, that each training job executed inside hyperparameter
4183+
* tuning is allowed to run as part of a hyperparameter tuning job. For more information, see
4184+
* the used by the action.</p>
41834185
*/
41844186
MaxRuntimePerTrainingJobInSeconds?: number;
41854187

@@ -4193,6 +4195,12 @@ export interface AutoMLJobCompletionCriteria {
41934195
MaxAutoMLJobRuntimeInSeconds?: number;
41944196
}
41954197

4198+
export enum AutoMLMode {
4199+
AUTO = "AUTO",
4200+
ENSEMBLING = "ENSEMBLING",
4201+
HYPERPARAMETER_TUNING = "HYPERPARAMETER_TUNING",
4202+
}
4203+
41964204
/**
41974205
* <p>Specifies a VPC that your training jobs and hosted models have access to. Control
41984206
* access to and from your training and model containers by configuring the VPC. For more
@@ -4259,6 +4267,26 @@ export interface AutoMLJobConfig {
42594267
* <p>The configuration for generating a candidate for an AutoML job (optional). </p>
42604268
*/
42614269
CandidateGenerationConfig?: AutoMLCandidateGenerationConfig;
4270+
4271+
/**
4272+
* <p>The method that Autopilot uses to train the data. You can either specify the mode manually
4273+
* or let Autopilot choose for you based on the dataset size by selecting <code>AUTO</code>. In
4274+
* <code>AUTO</code> mode, Autopilot chooses <code>ENSEMBLING</code> for datasets smaller than
4275+
* 100 MB, and <code>HYPERPARAMETER_TUNING</code> for larger ones.</p>
4276+
* <p>The <code>ENSEMBLING</code> mode uses a multi-stack ensemble model to predict
4277+
* classification and regression tasks directly from your dataset. This machine learning mode
4278+
* combines several base models to produce an optimal predictive model. It then uses a
4279+
* stacking ensemble method to combine predictions from contributing members. A multi-stack
4280+
* ensemble model can provide better performance over a single model by combining the
4281+
* predictive capabilities of multiple models. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-suppprt">Autopilot algorithm support</a> for a list of algorithms supported by
4282+
* <code>ENSEMBLING</code> mode.</p>
4283+
* <p>The <code>HYPERPARAMETER_TUNING</code> (HPO) mode uses the best hyperparameters to train
4284+
* the best version of a model. HPO will automatically select an algorithm for the type of
4285+
* problem you want to solve. Then HPO finds the best hyperparameters according to your
4286+
* objective metric. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-suppprt">Autopilot algorithm support</a> for a list of algorithms supported by
4287+
* <code>HYPERPARAMETER_TUNING</code> mode.</p>
4288+
*/
4289+
Mode?: AutoMLMode | string;
42624290
}
42634291

42644292
/**
@@ -8445,15 +8473,15 @@ export interface ProductionVariant {
84458473
VolumeSizeInGB?: number;
84468474

84478475
/**
8448-
* <p>The timeout value, in seconds, to download and extract customer
8449-
* model artifact from Amazon S3 to individual inference instance associated with
8476+
* <p>The timeout value, in seconds, to download and extract the
8477+
* model that you want to host from Amazon S3 to the individual inference instance associated with
84508478
* this production variant.</p>
84518479
*/
84528480
ModelDataDownloadTimeoutInSeconds?: number;
84538481

84548482
/**
8455-
* <p>The timeout value, in seconds, for the customer inference container
8456-
* to pass health check by SageMaker Hosting. For more information on health
8483+
* <p>The timeout value, in seconds, for your inference container
8484+
* to pass health check by SageMaker Hosting. For more information about health
84578485
* check, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests">How
84588486
* Your Container Should Respond to Health Check (Ping)
84598487
* Requests</a>.</p>
@@ -9861,11 +9889,6 @@ export enum HyperParameterTuningJobStrategyType {
98619889
RANDOM = "Random",
98629890
}
98639891

9864-
export enum TrainingJobEarlyStoppingType {
9865-
AUTO = "Auto",
9866-
OFF = "Off",
9867-
}
9868-
98699892
/**
98709893
* @internal
98719894
*/

clients/client-sagemaker/src/models/models_1.ts

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,6 @@ import {
9696
Tag,
9797
TrainingInputMode,
9898
TrainingInstanceType,
99-
TrainingJobEarlyStoppingType,
10099
TrainingSpecification,
101100
TransformInput,
102101
TransformJobDefinition,
@@ -107,6 +106,11 @@ import {
107106
VpcConfig,
108107
} from "./models_0";
109108

109+
export enum TrainingJobEarlyStoppingType {
110+
AUTO = "Auto",
111+
OFF = "Off",
112+
}
113+
110114
/**
111115
* <p>The job completion criteria.</p>
112116
*/
@@ -5656,6 +5660,12 @@ export interface CreateTrainingJobRequest {
56565660
* <p>You can specify a maximum of 100 hyperparameters. Each hyperparameter is a
56575661
* key-value pair. Each key and value is limited to 256 characters, as specified by the
56585662
* <code>Length Constraint</code>. </p>
5663+
* <important>
5664+
* <p>You must not include any security-sensitive information, such as
5665+
* account access IDs, secrets, and tokens, in the dictionary for configuring
5666+
* hyperparameters. SageMaker rejects the training job request and returns an
5667+
* exception error for detected credentials, if such user input is found.</p>
5668+
* </important>
56595669
*/
56605670
HyperParameters?: Record<string, string>;
56615671

@@ -9163,13 +9173,6 @@ export interface DescribeFeatureMetadataResponse {
91639173
Parameters?: FeatureParameter[];
91649174
}
91659175

9166-
export interface DescribeFlowDefinitionRequest {
9167-
/**
9168-
* <p>The name of the flow definition.</p>
9169-
*/
9170-
FlowDefinitionName: string | undefined;
9171-
}
9172-
91739176
/**
91749177
* @internal
91759178
*/
@@ -11118,10 +11121,3 @@ export const FeatureParameterFilterSensitiveLog = (obj: FeatureParameter): any =
1111811121
export const DescribeFeatureMetadataResponseFilterSensitiveLog = (obj: DescribeFeatureMetadataResponse): any => ({
1111911122
...obj,
1112011123
});
11121-
11122-
/**
11123-
* @internal
11124-
*/
11125-
export const DescribeFlowDefinitionRequestFilterSensitiveLog = (obj: DescribeFlowDefinitionRequest): any => ({
11126-
...obj,
11127-
});

clients/client-sagemaker/src/models/models_2.ts

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,13 @@ import {
142142
TrialComponentStatus,
143143
} from "./models_1";
144144

145+
export interface DescribeFlowDefinitionRequest {
146+
/**
147+
* <p>The name of the flow definition.</p>
148+
*/
149+
FlowDefinitionName: string | undefined;
150+
}
151+
145152
export enum FlowDefinitionStatus {
146153
ACTIVE = "Active",
147154
DELETING = "Deleting",
@@ -8833,10 +8840,12 @@ export enum NotebookInstanceSortKey {
88338840
STATUS = "Status",
88348841
}
88358842

8836-
export enum NotebookInstanceSortOrder {
8837-
ASCENDING = "Ascending",
8838-
DESCENDING = "Descending",
8839-
}
8843+
/**
8844+
* @internal
8845+
*/
8846+
export const DescribeFlowDefinitionRequestFilterSensitiveLog = (obj: DescribeFlowDefinitionRequest): any => ({
8847+
...obj,
8848+
});
88408849

88418850
/**
88428851
* @internal

clients/client-sagemaker/src/models/models_3.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,6 @@ import {
9999
ModelPackageGroupStatus,
100100
ModelPackageStatusDetails,
101101
NotebookInstanceSortKey,
102-
NotebookInstanceSortOrder,
103102
NotebookInstanceStatus,
104103
PipelineExecutionStatus,
105104
PipelineExperimentConfig,
@@ -123,6 +122,11 @@ import {
123122
Workteam,
124123
} from "./models_2";
125124

125+
export enum NotebookInstanceSortOrder {
126+
ASCENDING = "Ascending",
127+
DESCENDING = "Descending",
128+
}
129+
126130
export interface ListNotebookInstancesInput {
127131
/**
128132
* <p> If the previous call to the <code>ListNotebookInstances</code> is truncated, the

clients/client-sagemaker/src/protocols/Aws_json1_1.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1076,7 +1076,6 @@ import {
10761076
DescribeFeatureGroupResponse,
10771077
DescribeFeatureMetadataRequest,
10781078
DescribeFeatureMetadataResponse,
1079-
DescribeFlowDefinitionRequest,
10801079
DriftCheckBaselines,
10811080
DriftCheckBias,
10821081
DriftCheckExplainability,
@@ -1190,6 +1189,7 @@ import {
11901189
WorkforceVpcConfigRequest,
11911190
} from "../models/models_1";
11921191
import {
1192+
DescribeFlowDefinitionRequest,
11931193
DescribeFlowDefinitionResponse,
11941194
DescribeHumanTaskUiRequest,
11951195
DescribeHumanTaskUiResponse,
@@ -15663,6 +15663,7 @@ const serializeAws_json1_1AutoMLJobConfig = (input: AutoMLJobConfig, context: __
1566315663
...(input.DataSplitConfig != null && {
1566415664
DataSplitConfig: serializeAws_json1_1AutoMLDataSplitConfig(input.DataSplitConfig, context),
1566515665
}),
15666+
...(input.Mode != null && { Mode: input.Mode }),
1566615667
...(input.SecurityConfig != null && {
1566715668
SecurityConfig: serializeAws_json1_1AutoMLSecurityConfig(input.SecurityConfig, context),
1566815669
}),
@@ -23517,6 +23518,7 @@ const deserializeAws_json1_1AutoMLJobConfig = (output: any, context: __SerdeCont
2351723518
output.DataSplitConfig != null
2351823519
? deserializeAws_json1_1AutoMLDataSplitConfig(output.DataSplitConfig, context)
2351923520
: undefined,
23521+
Mode: __expectString(output.Mode),
2352023522
SecurityConfig:
2352123523
output.SecurityConfig != null
2352223524
? deserializeAws_json1_1AutoMLSecurityConfig(output.SecurityConfig, context)

0 commit comments

Comments
 (0)