Skip to content

Commit

Permalink
feat(client-sagemaker): Autopilot APIs will now support holiday featu…
Browse files Browse the repository at this point in the history
…rization for Timeseries models. The models will now hold holiday metadata and should be able to accommodate holiday effect during inference.
  • Loading branch information
awstools committed Sep 8, 2023
1 parent e2c27f4 commit ee36843
Show file tree
Hide file tree
Showing 11 changed files with 282 additions and 226 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ export interface CreateAutoMLJobCommandOutput extends CreateAutoMLJobResponse, _
* <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>
* <p>
* <code>CreateAutoMLJobV2</code> can manage tabular problem types identical to those of
* its previous version <code>CreateAutoMLJob</code>, as well as non-tabular problem types
* such as image or text classification.</p>
* its previous version <code>CreateAutoMLJob</code>, as well as time-series forecasting,
* and non-tabular problem types such as image or text classification.</p>
* <p>Find guidelines about how to migrate a <code>CreateAutoMLJob</code> to
* <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>
* </note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ export interface CreateAutoMLJobV2CommandOutput extends CreateAutoMLJobV2Respons
* and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html">DescribeAutoMLJob</a> which offer backward compatibility.</p>
* <p>
* <code>CreateAutoMLJobV2</code> can manage tabular problem types identical to those of
* its previous version <code>CreateAutoMLJob</code>, as well as non-tabular problem types
* such as image or text classification.</p>
* its previous version <code>CreateAutoMLJob</code>, as well as time-series forecasting,
* and non-tabular problem types such as image or text classification.</p>
* <p>Find guidelines about how to migrate a <code>CreateAutoMLJob</code> to
* <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>
* </note>
Expand Down Expand Up @@ -145,6 +145,11 @@ export interface CreateAutoMLJobV2CommandOutput extends CreateAutoMLJobV2Respons
* "STRING_VALUE",
* ],
* },
* HolidayConfig: [ // HolidayConfig
* { // HolidayConfigAttributes
* CountryCode: "STRING_VALUE",
* },
* ],
* },
* },
* RoleArn: "STRING_VALUE", // required
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ import {
SerdeContext as __SerdeContext,
} from "@smithy/types";

import { DeleteExperimentRequest } from "../models/models_1";
import { DeleteExperimentResponse } from "../models/models_2";
import { DeleteExperimentRequest, DeleteExperimentResponse } from "../models/models_2";
import { de_DeleteExperimentCommand, se_DeleteExperimentCommand } from "../protocols/Aws_json1_1";
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,11 @@ export interface DescribeAutoMLJobV2CommandOutput extends DescribeAutoMLJobV2Res
* // "STRING_VALUE",
* // ],
* // },
* // HolidayConfig: [ // HolidayConfig
* // { // HolidayConfigAttributes
* // CountryCode: "STRING_VALUE",
* // },
* // ],
* // },
* // },
* // CreationTime: new Date("TIMESTAMP"), // required
Expand Down
67 changes: 25 additions & 42 deletions clients/client-sagemaker/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5923,6 +5923,22 @@ export interface TextClassificationJobConfig {
TargetLabelColumn: string | undefined;
}

/**
* @public
* <p>Stores the holiday featurization attributes applicable to each item of time-series
* datasets during the training of a forecasting model. This allows the model to identify
* patterns associated with specific holidays.</p>
*/
export interface HolidayConfigAttributes {
/**
* @public
* <p>The country code for the holiday calendar.</p>
* <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
* choice.</p>
*/
CountryCode?: string;
}

/**
* @public
* <p>The collection of components that defines the time-series.</p>
Expand Down Expand Up @@ -6041,11 +6057,6 @@ export interface TimeSeriesTransformations {
* @public
* <p>The collection of settings used by an AutoML job V2 for the time-series forecasting
* problem type.</p>
* <note>
* <p>The <code>TimeSeriesForecastingJobConfig</code> problem type is only available in
* private beta. Contact Amazon Web Services Support or your account manager to learn more
* about access privileges.</p>
* </note>
*/
export interface TimeSeriesForecastingJobConfig {
/**
Expand Down Expand Up @@ -6126,8 +6137,8 @@ export interface TimeSeriesForecastingJobConfig {
* <p>The quantiles used to train the model for forecasts at a specified quantile. You can
* specify quantiles from <code>0.01</code> (p1) to <code>0.99</code> (p99), by increments of
* 0.01 or higher. Up to five forecast quantiles can be specified. When
* <code>ForecastQuantiles</code> is not provided, the AutoML job uses the quantiles
* p10, p50, and p90 as default.</p>
* <code>ForecastQuantiles</code> is not provided, the AutoML job uses the quantiles p10,
* p50, and p90 as default.</p>
*/
ForecastQuantiles?: string[];

Expand All @@ -6143,6 +6154,13 @@ export interface TimeSeriesForecastingJobConfig {
* <p>The collection of components that defines the time-series.</p>
*/
TimeSeriesConfig: TimeSeriesConfig | undefined;

/**
* @public
* <p>The collection of holiday featurization attributes used to incorporate national holiday
* information into your forecasting model.</p>
*/
HolidayConfig?: HolidayConfigAttributes[];
}

/**
Expand Down Expand Up @@ -6204,11 +6222,6 @@ export namespace AutoMLProblemTypeConfig {
* @public
* <p>Settings used to configure an AutoML job V2 for a time-series forecasting problem
* type.</p>
* <note>
* <p>The <code>TimeSeriesForecastingJobConfig</code> problem type is only available in
* private beta. Contact Amazon Web Services Support or your account manager to learn more
* about access privileges.</p>
* </note>
*/
export interface TimeSeriesForecastingJobConfigMember {
ImageClassificationJobConfig?: never;
Expand Down Expand Up @@ -11495,33 +11508,3 @@ export interface KernelGatewayAppSettings {
*/
LifecycleConfigArns?: string[];
}

/**
* @public
* <p>A collection of settings that apply to spaces created in the Domain.</p>
*/
export interface DefaultSpaceSettings {
/**
* @public
* <p>The ARN of the execution role for the space.</p>
*/
ExecutionRole?: string;

/**
* @public
* <p>The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.</p>
*/
SecurityGroups?: string[];

/**
* @public
* <p>The JupyterServer app settings.</p>
*/
JupyterServerAppSettings?: JupyterServerAppSettings;

/**
* @public
* <p>The KernelGateway app settings.</p>
*/
KernelGatewayAppSettings?: KernelGatewayAppSettings;
}
42 changes: 30 additions & 12 deletions clients/client-sagemaker/src/models/models_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ import {
ContinuousParameterRange,
ConvergenceDetected,
CustomImage,
DefaultSpaceSettings,
EdgeOutputConfig,
EndpointInput,
HyperParameterScalingType,
Expand Down Expand Up @@ -78,6 +77,36 @@ import {
VpcConfig,
} from "./models_0";

/**
* @public
* <p>A collection of settings that apply to spaces created in the Domain.</p>
*/
export interface DefaultSpaceSettings {
/**
* @public
* <p>The ARN of the execution role for the space.</p>
*/
ExecutionRole?: string;

/**
* @public
* <p>The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.</p>
*/
SecurityGroups?: string[];

/**
* @public
* <p>The JupyterServer app settings.</p>
*/
JupyterServerAppSettings?: JupyterServerAppSettings;

/**
* @public
* <p>The KernelGateway app settings.</p>
*/
KernelGatewayAppSettings?: KernelGatewayAppSettings;
}

/**
* @public
* <p>A collection of settings that apply to an <code>RSessionGateway</code> app.</p>
Expand Down Expand Up @@ -11738,17 +11767,6 @@ export interface DeleteEndpointConfigInput {
EndpointConfigName: string | undefined;
}

/**
* @public
*/
export interface DeleteExperimentRequest {
/**
* @public
* <p>The name of the experiment to delete.</p>
*/
ExperimentName: string | undefined;
}

/**
* @internal
*/
Expand Down
55 changes: 12 additions & 43 deletions clients/client-sagemaker/src/models/models_2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ import {
DataQualityAppSpecification,
DataQualityBaselineConfig,
DataQualityJobInput,
DefaultSpaceSettings,
EdgeOutputConfig,
EdgePresetDeploymentType,
GitConfig,
Expand Down Expand Up @@ -88,6 +87,7 @@ import {
DebugHookConfig,
DebugRuleConfiguration,
DebugRuleEvaluationStatus,
DefaultSpaceSettings,
DeploymentConfig,
DeviceSelectionConfig,
DirectInternetAccess,
Expand Down Expand Up @@ -176,6 +176,17 @@ import {
VendorGuidance,
} from "./models_1";

/**
* @public
*/
export interface DeleteExperimentRequest {
/**
* @public
* <p>The name of the experiment to delete.</p>
*/
ExperimentName: string | undefined;
}

/**
* @public
*/
Expand Down Expand Up @@ -11121,48 +11132,6 @@ export const FeatureGroupSortOrder = {
*/
export type FeatureGroupSortOrder = (typeof FeatureGroupSortOrder)[keyof typeof FeatureGroupSortOrder];

/**
* @public
* <p>The name, ARN, <code>CreationTime</code>, <code>FeatureGroup</code> values,
* <code>LastUpdatedTime</code> and <code>EnableOnlineStorage</code> status of a
* <code>FeatureGroup</code>.</p>
*/
export interface FeatureGroupSummary {
/**
* @public
* <p>The name of <code>FeatureGroup</code>.</p>
*/
FeatureGroupName: string | undefined;

/**
* @public
* <p>Unique identifier for the <code>FeatureGroup</code>.</p>
*/
FeatureGroupArn: string | undefined;

/**
* @public
* <p>A timestamp indicating the time of creation time of the
* <code>FeatureGroup</code>.</p>
*/
CreationTime: Date | undefined;

/**
* @public
* <p>The status of a FeatureGroup. The status can be any of the following:
* <code>Creating</code>, <code>Created</code>, <code>CreateFail</code>,
* <code>Deleting</code> or <code>DetailFail</code>. </p>
*/
FeatureGroupStatus?: FeatureGroupStatus | string;

/**
* @public
* <p>Notifies you if replicating data into the <code>OfflineStore</code> has failed. Returns
* either: <code>Active</code> or <code>Blocked</code>.</p>
*/
OfflineStoreStatus?: OfflineStoreStatus;
}

/**
* @internal
*/
Expand Down
Loading

0 comments on commit ee36843

Please sign in to comment.