Skip to content

Commit ee36843

Browse files
author
awstools
committed
feat(client-sagemaker): Autopilot APIs will now support holiday featurization for Timeseries models. The models will now hold holiday metadata and should be able to accommodate holiday effect during inference.
1 parent e2c27f4 commit ee36843

File tree

11 files changed

+282
-226
lines changed

11 files changed

+282
-226
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ export interface CreateAutoMLJobCommandOutput extends CreateAutoMLJobResponse, _
4141
* <p>We recommend using the new versions <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html">CreateAutoMLJobV2</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html">DescribeAutoMLJobV2</a>, which offer backward compatibility.</p>
4242
* <p>
4343
* <code>CreateAutoMLJobV2</code> can manage tabular problem types identical to those of
44-
* its previous version <code>CreateAutoMLJob</code>, as well as non-tabular problem types
45-
* such as image or text classification.</p>
44+
* its previous version <code>CreateAutoMLJob</code>, as well as time-series forecasting,
45+
* and non-tabular problem types such as image or text classification.</p>
4646
* <p>Find guidelines about how to migrate a <code>CreateAutoMLJob</code> to
4747
* <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>
4848
* </note>

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ export interface CreateAutoMLJobV2CommandOutput extends CreateAutoMLJobV2Respons
4343
* and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html">DescribeAutoMLJob</a> which offer backward compatibility.</p>
4444
* <p>
4545
* <code>CreateAutoMLJobV2</code> can manage tabular problem types identical to those of
46-
* its previous version <code>CreateAutoMLJob</code>, as well as non-tabular problem types
47-
* such as image or text classification.</p>
46+
* its previous version <code>CreateAutoMLJob</code>, as well as time-series forecasting,
47+
* and non-tabular problem types such as image or text classification.</p>
4848
* <p>Find guidelines about how to migrate a <code>CreateAutoMLJob</code> to
4949
* <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>
5050
* </note>
@@ -145,6 +145,11 @@ export interface CreateAutoMLJobV2CommandOutput extends CreateAutoMLJobV2Respons
145145
* "STRING_VALUE",
146146
* ],
147147
* },
148+
* HolidayConfig: [ // HolidayConfig
149+
* { // HolidayConfigAttributes
150+
* CountryCode: "STRING_VALUE",
151+
* },
152+
* ],
148153
* },
149154
* },
150155
* RoleArn: "STRING_VALUE", // required

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ import {
1313
SerdeContext as __SerdeContext,
1414
} from "@smithy/types";
1515

16-
import { DeleteExperimentRequest } from "../models/models_1";
17-
import { DeleteExperimentResponse } from "../models/models_2";
16+
import { DeleteExperimentRequest, DeleteExperimentResponse } from "../models/models_2";
1817
import { de_DeleteExperimentCommand, se_DeleteExperimentCommand } from "../protocols/Aws_json1_1";
1918
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
2019

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,11 @@ export interface DescribeAutoMLJobV2CommandOutput extends DescribeAutoMLJobV2Res
142142
* // "STRING_VALUE",
143143
* // ],
144144
* // },
145+
* // HolidayConfig: [ // HolidayConfig
146+
* // { // HolidayConfigAttributes
147+
* // CountryCode: "STRING_VALUE",
148+
* // },
149+
* // ],
145150
* // },
146151
* // },
147152
* // CreationTime: new Date("TIMESTAMP"), // required

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

Lines changed: 25 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -5923,6 +5923,22 @@ export interface TextClassificationJobConfig {
59235923
TargetLabelColumn: string | undefined;
59245924
}
59255925

5926+
/**
5927+
* @public
5928+
* <p>Stores the holiday featurization attributes applicable to each item of time-series
5929+
* datasets during the training of a forecasting model. This allows the model to identify
5930+
* patterns associated with specific holidays.</p>
5931+
*/
5932+
export interface HolidayConfigAttributes {
5933+
/**
5934+
* @public
5935+
* <p>The country code for the holiday calendar.</p>
5936+
* <p>For the list of public holiday calendars supported by AutoML job V2, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/holidays.html#holidays-country-codes">Country Codes</a>. Use the country code corresponding to the country of your
5937+
* choice.</p>
5938+
*/
5939+
CountryCode?: string;
5940+
}
5941+
59265942
/**
59275943
* @public
59285944
* <p>The collection of components that defines the time-series.</p>
@@ -6041,11 +6057,6 @@ export interface TimeSeriesTransformations {
60416057
* @public
60426058
* <p>The collection of settings used by an AutoML job V2 for the time-series forecasting
60436059
* problem type.</p>
6044-
* <note>
6045-
* <p>The <code>TimeSeriesForecastingJobConfig</code> problem type is only available in
6046-
* private beta. Contact Amazon Web Services Support or your account manager to learn more
6047-
* about access privileges.</p>
6048-
* </note>
60496060
*/
60506061
export interface TimeSeriesForecastingJobConfig {
60516062
/**
@@ -6126,8 +6137,8 @@ export interface TimeSeriesForecastingJobConfig {
61266137
* <p>The quantiles used to train the model for forecasts at a specified quantile. You can
61276138
* specify quantiles from <code>0.01</code> (p1) to <code>0.99</code> (p99), by increments of
61286139
* 0.01 or higher. Up to five forecast quantiles can be specified. When
6129-
* <code>ForecastQuantiles</code> is not provided, the AutoML job uses the quantiles
6130-
* p10, p50, and p90 as default.</p>
6140+
* <code>ForecastQuantiles</code> is not provided, the AutoML job uses the quantiles p10,
6141+
* p50, and p90 as default.</p>
61316142
*/
61326143
ForecastQuantiles?: string[];
61336144

@@ -6143,6 +6154,13 @@ export interface TimeSeriesForecastingJobConfig {
61436154
* <p>The collection of components that defines the time-series.</p>
61446155
*/
61456156
TimeSeriesConfig: TimeSeriesConfig | undefined;
6157+
6158+
/**
6159+
* @public
6160+
* <p>The collection of holiday featurization attributes used to incorporate national holiday
6161+
* information into your forecasting model.</p>
6162+
*/
6163+
HolidayConfig?: HolidayConfigAttributes[];
61466164
}
61476165

61486166
/**
@@ -6204,11 +6222,6 @@ export namespace AutoMLProblemTypeConfig {
62046222
* @public
62056223
* <p>Settings used to configure an AutoML job V2 for a time-series forecasting problem
62066224
* type.</p>
6207-
* <note>
6208-
* <p>The <code>TimeSeriesForecastingJobConfig</code> problem type is only available in
6209-
* private beta. Contact Amazon Web Services Support or your account manager to learn more
6210-
* about access privileges.</p>
6211-
* </note>
62126225
*/
62136226
export interface TimeSeriesForecastingJobConfigMember {
62146227
ImageClassificationJobConfig?: never;
@@ -11495,33 +11508,3 @@ export interface KernelGatewayAppSettings {
1149511508
*/
1149611509
LifecycleConfigArns?: string[];
1149711510
}
11498-
11499-
/**
11500-
* @public
11501-
* <p>A collection of settings that apply to spaces created in the Domain.</p>
11502-
*/
11503-
export interface DefaultSpaceSettings {
11504-
/**
11505-
* @public
11506-
* <p>The ARN of the execution role for the space.</p>
11507-
*/
11508-
ExecutionRole?: string;
11509-
11510-
/**
11511-
* @public
11512-
* <p>The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.</p>
11513-
*/
11514-
SecurityGroups?: string[];
11515-
11516-
/**
11517-
* @public
11518-
* <p>The JupyterServer app settings.</p>
11519-
*/
11520-
JupyterServerAppSettings?: JupyterServerAppSettings;
11521-
11522-
/**
11523-
* @public
11524-
* <p>The KernelGateway app settings.</p>
11525-
*/
11526-
KernelGatewayAppSettings?: KernelGatewayAppSettings;
11527-
}

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

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ import {
4141
ContinuousParameterRange,
4242
ConvergenceDetected,
4343
CustomImage,
44-
DefaultSpaceSettings,
4544
EdgeOutputConfig,
4645
EndpointInput,
4746
HyperParameterScalingType,
@@ -78,6 +77,36 @@ import {
7877
VpcConfig,
7978
} from "./models_0";
8079

80+
/**
81+
* @public
82+
* <p>A collection of settings that apply to spaces created in the Domain.</p>
83+
*/
84+
export interface DefaultSpaceSettings {
85+
/**
86+
* @public
87+
* <p>The ARN of the execution role for the space.</p>
88+
*/
89+
ExecutionRole?: string;
90+
91+
/**
92+
* @public
93+
* <p>The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.</p>
94+
*/
95+
SecurityGroups?: string[];
96+
97+
/**
98+
* @public
99+
* <p>The JupyterServer app settings.</p>
100+
*/
101+
JupyterServerAppSettings?: JupyterServerAppSettings;
102+
103+
/**
104+
* @public
105+
* <p>The KernelGateway app settings.</p>
106+
*/
107+
KernelGatewayAppSettings?: KernelGatewayAppSettings;
108+
}
109+
81110
/**
82111
* @public
83112
* <p>A collection of settings that apply to an <code>RSessionGateway</code> app.</p>
@@ -11738,17 +11767,6 @@ export interface DeleteEndpointConfigInput {
1173811767
EndpointConfigName: string | undefined;
1173911768
}
1174011769

11741-
/**
11742-
* @public
11743-
*/
11744-
export interface DeleteExperimentRequest {
11745-
/**
11746-
* @public
11747-
* <p>The name of the experiment to delete.</p>
11748-
*/
11749-
ExperimentName: string | undefined;
11750-
}
11751-
1175211770
/**
1175311771
* @internal
1175411772
*/

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

Lines changed: 12 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ import {
4646
DataQualityAppSpecification,
4747
DataQualityBaselineConfig,
4848
DataQualityJobInput,
49-
DefaultSpaceSettings,
5049
EdgeOutputConfig,
5150
EdgePresetDeploymentType,
5251
GitConfig,
@@ -88,6 +87,7 @@ import {
8887
DebugHookConfig,
8988
DebugRuleConfiguration,
9089
DebugRuleEvaluationStatus,
90+
DefaultSpaceSettings,
9191
DeploymentConfig,
9292
DeviceSelectionConfig,
9393
DirectInternetAccess,
@@ -176,6 +176,17 @@ import {
176176
VendorGuidance,
177177
} from "./models_1";
178178

179+
/**
180+
* @public
181+
*/
182+
export interface DeleteExperimentRequest {
183+
/**
184+
* @public
185+
* <p>The name of the experiment to delete.</p>
186+
*/
187+
ExperimentName: string | undefined;
188+
}
189+
179190
/**
180191
* @public
181192
*/
@@ -11121,48 +11132,6 @@ export const FeatureGroupSortOrder = {
1112111132
*/
1112211133
export type FeatureGroupSortOrder = (typeof FeatureGroupSortOrder)[keyof typeof FeatureGroupSortOrder];
1112311134

11124-
/**
11125-
* @public
11126-
* <p>The name, ARN, <code>CreationTime</code>, <code>FeatureGroup</code> values,
11127-
* <code>LastUpdatedTime</code> and <code>EnableOnlineStorage</code> status of a
11128-
* <code>FeatureGroup</code>.</p>
11129-
*/
11130-
export interface FeatureGroupSummary {
11131-
/**
11132-
* @public
11133-
* <p>The name of <code>FeatureGroup</code>.</p>
11134-
*/
11135-
FeatureGroupName: string | undefined;
11136-
11137-
/**
11138-
* @public
11139-
* <p>Unique identifier for the <code>FeatureGroup</code>.</p>
11140-
*/
11141-
FeatureGroupArn: string | undefined;
11142-
11143-
/**
11144-
* @public
11145-
* <p>A timestamp indicating the time of creation time of the
11146-
* <code>FeatureGroup</code>.</p>
11147-
*/
11148-
CreationTime: Date | undefined;
11149-
11150-
/**
11151-
* @public
11152-
* <p>The status of a FeatureGroup. The status can be any of the following:
11153-
* <code>Creating</code>, <code>Created</code>, <code>CreateFail</code>,
11154-
* <code>Deleting</code> or <code>DetailFail</code>. </p>
11155-
*/
11156-
FeatureGroupStatus?: FeatureGroupStatus | string;
11157-
11158-
/**
11159-
* @public
11160-
* <p>Notifies you if replicating data into the <code>OfflineStore</code> has failed. Returns
11161-
* either: <code>Active</code> or <code>Blocked</code>.</p>
11162-
*/
11163-
OfflineStoreStatus?: OfflineStoreStatus;
11164-
}
11165-
1116611135
/**
1116711136
* @internal
1116811137
*/

0 commit comments

Comments
 (0)