Skip to content

Commit cf5df1e

Browse files
author
awstools
committed
feat(client-sagemaker): Amazon Sagemaker Autopilot releases CreateAutoMLJobV2 and DescribeAutoMLJobV2 for Autopilot customers with ImageClassification, TextClassification and Tabular problem type config support.
1 parent a02f0d7 commit cf5df1e

21 files changed

+1161
-626
lines changed

‎clients/client-sagemaker/src/commands/CreateAutoMLJobCommand.ts‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,17 @@ export interface CreateAutoMLJobCommandOutput extends CreateAutoMLJobResponse, _
3636

3737
/**
3838
* @public
39-
* <p>Creates an Autopilot job.</p>
40-
* <p>Find the best-performing model after you run an Autopilot job by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html">DescribeAutoMLJob</a>.</p>
41-
* <p>For information about how to use Autopilot, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html">Automate Model
42-
* Development with Amazon SageMaker Autopilot</a>.</p>
39+
* <p>Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.</p>
40+
* <p>Find the best-performing model after you run an AutoML job by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html">DescribeAutoMLJobV2</a> (recommended) or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html">DescribeAutoMLJob</a>.</p>
41+
* <note>
42+
* <p>
43+
* <code>CreateAutoMLJob</code> only accepts tabular input data. We recommend using
44+
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html">CreateAutoMLJobV2</a> for all problem types. <code>CreateAutoMLJobV2</code> can
45+
* process the same tabular data as its previous version <code>CreateAutoMLJob</code>, as
46+
* well as non-tabular data for problem types such as image or text classification.</p>
47+
* <p>Find guidelines about how to migrate <code>CreateAutoMLJob</code> to
48+
* <code>CreateAutoMLJobV2</code> in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-create-experiment-api.html#autopilot-create-experiment-api-migrate-v1-v2">Migrate a CreateAutoMLJob to CreateAutoMLJobV2</a>.</p>
49+
* </note>
4350
* @example
4451
* Use a bare-bones client and the command you need to make an API call.
4552
* ```javascript

‎clients/client-sagemaker/src/commands/CreateAutoMLJobV2Command.ts‎

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,17 @@ export interface CreateAutoMLJobV2CommandOutput extends CreateAutoMLJobV2Respons
3636

3737
/**
3838
* @public
39-
* <p>Creates an Amazon SageMaker AutoML job that uses non-tabular data such as images or text for
40-
* Computer Vision or Natural Language Processing problems.</p>
41-
* <p>Find the resulting model after you run an AutoML job V2 by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html">DescribeAutoMLJobV2</a>.</p>
42-
* <p>To create an <code>AutoMLJob</code> using tabular data, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html">CreateAutoMLJob</a>.</p>
43-
* <note>
44-
* <p>This API action is callable through SageMaker Canvas only. Calling it directly from the CLI
45-
* or an SDK results in an error.</p>
46-
* </note>
39+
* <p>Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.</p>
40+
* <p>We recommend using <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html">CreateAutoMLJobV2</a>
41+
* for all problem types. <code>CreateAutoMLJobV2</code> can process the same tabular data as
42+
* its previous version <code>CreateAutoMLJob</code>, as well as non-tabular data for problem
43+
* types such as image or text classification.</p>
44+
* <p>Find guidelines about how to migrate <code>CreateAutoMLJob</code> to
45+
* <code>CreateAutoMLJobV2</code> in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-create-experiment-api.html#autopilot-create-experiment-api-migrate-v1-v2">Migrate a CreateAutoMLJob to CreateAutoMLJobV2</a>.</p>
46+
* <p>For the list of available problem types supported by <code>CreateAutoMLJobV2</code>, see
47+
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLProblemTypeConfig.html">AutoMLProblemTypeConfig</a>.</p>
48+
* <p>Find the best-performing model after you run an AutoML job V2 by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html">DescribeAutoMLJobV2</a>. Calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html">DescribeAutoMLJob</a>
49+
* on a AutoML job V2 results in an error.</p>
4750
* @example
4851
* Use a bare-bones client and the command you need to make an API call.
4952
* ```javascript
@@ -86,6 +89,28 @@ export interface CreateAutoMLJobV2CommandOutput extends CreateAutoMLJobV2Respons
8689
* ContentColumn: "STRING_VALUE",
8790
* TargetLabelColumn: "STRING_VALUE",
8891
* },
92+
* TabularJobConfig: { // TabularJobConfig
93+
* CandidateGenerationConfig: { // CandidateGenerationConfig
94+
* AlgorithmsConfig: [ // AutoMLAlgorithmsConfig
95+
* { // AutoMLAlgorithmConfig
96+
* AutoMLAlgorithms: [ // AutoMLAlgorithms // required
97+
* "xgboost" || "linear-learner" || "mlp" || "lightgbm" || "catboost" || "randomforest" || "extra-trees" || "nn-torch" || "fastai",
98+
* ],
99+
* },
100+
* ],
101+
* },
102+
* CompletionCriteria: {
103+
* MaxCandidates: Number("int"),
104+
* MaxRuntimePerTrainingJobInSeconds: Number("int"),
105+
* MaxAutoMLJobRuntimeInSeconds: Number("int"),
106+
* },
107+
* FeatureSpecificationS3Uri: "STRING_VALUE",
108+
* Mode: "AUTO" || "ENSEMBLING" || "HYPERPARAMETER_TUNING",
109+
* GenerateCandidateDefinitionsOnly: true || false,
110+
* ProblemType: "BinaryClassification" || "MulticlassClassification" || "Regression",
111+
* TargetAttributeName: "STRING_VALUE", // required
112+
* SampleWeightAttributeName: "STRING_VALUE",
113+
* },
89114
* },
90115
* RoleArn: "STRING_VALUE", // required
91116
* Tags: [ // TagList

‎clients/client-sagemaker/src/commands/DeleteModelQualityJobDefinitionCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import {
1313
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
1414
import { SerdeContext as __SerdeContext } from "@smithy/types";
1515

16-
import { DeleteModelQualityJobDefinitionRequest } from "../models/models_1";
16+
import { DeleteModelQualityJobDefinitionRequest } from "../models/models_2";
1717
import {
1818
de_DeleteModelQualityJobDefinitionCommand,
1919
se_DeleteModelQualityJobDefinitionCommand,

‎clients/client-sagemaker/src/commands/DeleteMonitoringScheduleCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import {
1313
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
1414
import { SerdeContext as __SerdeContext } from "@smithy/types";
1515

16-
import { DeleteMonitoringScheduleRequest } from "../models/models_1";
16+
import { DeleteMonitoringScheduleRequest } from "../models/models_2";
1717
import { de_DeleteMonitoringScheduleCommand, se_DeleteMonitoringScheduleCommand } from "../protocols/Aws_json1_1";
1818
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
1919

‎clients/client-sagemaker/src/commands/DeleteNotebookInstanceCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import {
1313
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
1414
import { SerdeContext as __SerdeContext } from "@smithy/types";
1515

16-
import { DeleteNotebookInstanceInput } from "../models/models_1";
16+
import { DeleteNotebookInstanceInput } from "../models/models_2";
1717
import { de_DeleteNotebookInstanceCommand, se_DeleteNotebookInstanceCommand } from "../protocols/Aws_json1_1";
1818
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
1919

‎clients/client-sagemaker/src/commands/DeleteNotebookInstanceLifecycleConfigCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import {
1313
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
1414
import { SerdeContext as __SerdeContext } from "@smithy/types";
1515

16-
import { DeleteNotebookInstanceLifecycleConfigInput } from "../models/models_1";
16+
import { DeleteNotebookInstanceLifecycleConfigInput } from "../models/models_2";
1717
import {
1818
de_DeleteNotebookInstanceLifecycleConfigCommand,
1919
se_DeleteNotebookInstanceLifecycleConfigCommand,

‎clients/client-sagemaker/src/commands/DeletePipelineCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import {
1313
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
1414
import { SerdeContext as __SerdeContext } from "@smithy/types";
1515

16-
import { DeletePipelineRequest, DeletePipelineResponse } from "../models/models_1";
16+
import { DeletePipelineRequest, DeletePipelineResponse } from "../models/models_2";
1717
import { de_DeletePipelineCommand, se_DeletePipelineCommand } from "../protocols/Aws_json1_1";
1818
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
1919

‎clients/client-sagemaker/src/commands/DescribeAutoMLJobCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface DescribeAutoMLJobCommandOutput extends DescribeAutoMLJobRespons
3636

3737
/**
3838
* @public
39-
* <p>Returns information about an Amazon SageMaker AutoML job.</p>
39+
* <p>Returns information about an AutoML job created by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html">CreateAutoMLJob</a>.</p>
4040
* @example
4141
* Use a bare-bones client and the command you need to make an API call.
4242
* ```javascript

‎clients/client-sagemaker/src/commands/DescribeAutoMLJobV2Command.ts‎

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,7 @@ export interface DescribeAutoMLJobV2CommandOutput extends DescribeAutoMLJobV2Res
3636

3737
/**
3838
* @public
39-
* <p>Returns information about an Amazon SageMaker AutoML V2 job.</p>
40-
* <note>
41-
* <p>This API action is callable through SageMaker Canvas only. Calling it directly from the CLI
42-
* or an SDK results in an error.</p>
43-
* </note>
39+
* <p>Returns information about an AutoML job V2 created by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html">CreateAutoMLJobV2</a>.</p>
4440
* @example
4541
* Use a bare-bones client and the command you need to make an API call.
4642
* ```javascript
@@ -93,6 +89,28 @@ export interface DescribeAutoMLJobV2CommandOutput extends DescribeAutoMLJobV2Res
9389
* // ContentColumn: "STRING_VALUE",
9490
* // TargetLabelColumn: "STRING_VALUE",
9591
* // },
92+
* // TabularJobConfig: { // TabularJobConfig
93+
* // CandidateGenerationConfig: { // CandidateGenerationConfig
94+
* // AlgorithmsConfig: [ // AutoMLAlgorithmsConfig
95+
* // { // AutoMLAlgorithmConfig
96+
* // AutoMLAlgorithms: [ // AutoMLAlgorithms // required
97+
* // "xgboost" || "linear-learner" || "mlp" || "lightgbm" || "catboost" || "randomforest" || "extra-trees" || "nn-torch" || "fastai",
98+
* // ],
99+
* // },
100+
* // ],
101+
* // },
102+
* // CompletionCriteria: {
103+
* // MaxCandidates: Number("int"),
104+
* // MaxRuntimePerTrainingJobInSeconds: Number("int"),
105+
* // MaxAutoMLJobRuntimeInSeconds: Number("int"),
106+
* // },
107+
* // FeatureSpecificationS3Uri: "STRING_VALUE",
108+
* // Mode: "AUTO" || "ENSEMBLING" || "HYPERPARAMETER_TUNING",
109+
* // GenerateCandidateDefinitionsOnly: true || false,
110+
* // ProblemType: "BinaryClassification" || "MulticlassClassification" || "Regression",
111+
* // TargetAttributeName: "STRING_VALUE", // required
112+
* // SampleWeightAttributeName: "STRING_VALUE",
113+
* // },
96114
* // },
97115
* // CreationTime: new Date("TIMESTAMP"), // required
98116
* // EndTime: new Date("TIMESTAMP"),
@@ -183,6 +201,26 @@ export interface DescribeAutoMLJobV2CommandOutput extends DescribeAutoMLJobV2Res
183201
* // ],
184202
* // },
185203
* // },
204+
* // AutoMLJobArtifacts: { // AutoMLJobArtifacts
205+
* // CandidateDefinitionNotebookLocation: "STRING_VALUE",
206+
* // DataExplorationNotebookLocation: "STRING_VALUE",
207+
* // },
208+
* // ResolvedAttributes: { // AutoMLResolvedAttributes
209+
* // AutoMLJobObjective: {
210+
* // MetricName: "Accuracy" || "MSE" || "F1" || "F1macro" || "AUC" || "RMSE" || "MAE" || "R2" || "BalancedAccuracy" || "Precision" || "PrecisionMacro" || "Recall" || "RecallMacro", // required
211+
* // },
212+
* // CompletionCriteria: {
213+
* // MaxCandidates: Number("int"),
214+
* // MaxRuntimePerTrainingJobInSeconds: Number("int"),
215+
* // MaxAutoMLJobRuntimeInSeconds: Number("int"),
216+
* // },
217+
* // AutoMLProblemTypeResolvedAttributes: { // AutoMLProblemTypeResolvedAttributes Union: only one key present
218+
* // TabularResolvedAttributes: { // TabularResolvedAttributes
219+
* // ProblemType: "BinaryClassification" || "MulticlassClassification" || "Regression",
220+
* // },
221+
* // },
222+
* // },
223+
* // AutoMLProblemTypeConfigName: "ImageClassification" || "TextClassification" || "Tabular",
186224
* // };
187225
*
188226
* ```

‎clients/client-sagemaker/src/commands/StopCompilationJobCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import {
1313
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
1414
import { SerdeContext as __SerdeContext } from "@smithy/types";
1515

16-
import { StopCompilationJobRequest } from "../models/models_3";
16+
import { StopCompilationJobRequest } from "../models/models_4";
1717
import { de_StopCompilationJobCommand, se_StopCompilationJobCommand } from "../protocols/Aws_json1_1";
1818
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
1919

0 commit comments

Comments
 (0)