@aws-sdk/client-sagemaker 3.171.0 → 3.176.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/dist-cjs/commands/DescribeFeatureGroupCommand.js +2 -1
- package/dist-cjs/commands/DescribeFeatureMetadataCommand.js +3 -3
- package/dist-cjs/commands/ListNotebookInstanceLifecycleConfigsCommand.js +3 -3
- package/dist-cjs/models/models_0.js +17 -17
- package/dist-cjs/models/models_1.js +29 -27
- package/dist-cjs/models/models_2.js +25 -28
- package/dist-cjs/models/models_3.js +27 -4
- package/dist-cjs/protocols/Aws_json1_1.js +64 -0
- package/dist-es/commands/DescribeFeatureGroupCommand.js +2 -1
- package/dist-es/commands/DescribeFeatureMetadataCommand.js +1 -1
- package/dist-es/commands/ListNotebookInstanceLifecycleConfigsCommand.js +1 -1
- package/dist-es/models/models_0.js +7 -7
- package/dist-es/models/models_1.js +10 -5
- package/dist-es/models/models_2.js +5 -14
- package/dist-es/models/models_3.js +14 -0
- package/dist-es/protocols/Aws_json1_1.js +55 -3
- package/dist-types/SageMaker.d.ts +9 -9
- package/dist-types/commands/CreateAppCommand.d.ts +1 -2
- package/dist-types/commands/CreateTrainingJobCommand.d.ts +6 -5
- package/dist-types/commands/CreateUserProfileCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDomainCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFeatureGroupCommand.d.ts +2 -1
- package/dist-types/commands/DescribeFeatureMetadataCommand.d.ts +1 -1
- package/dist-types/commands/ListNotebookInstanceLifecycleConfigsCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +76 -80
- package/dist-types/models/models_1.d.ts +167 -197
- package/dist-types/models/models_2.d.ts +194 -108
- package/dist-types/models/models_3.d.ts +101 -2
- package/dist-types/ts3.4/commands/DescribeFeatureGroupCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeFeatureMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListNotebookInstanceLifecycleConfigsCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +18 -19
- package/dist-types/ts3.4/models/models_1.d.ts +37 -63
- package/dist-types/ts3.4/models/models_2.d.ts +58 -43
- package/dist-types/ts3.4/models/models_3.d.ts +41 -2
- package/package.json +1 -1
|
@@ -3757,9 +3757,28 @@ export interface AutoMLCandidate {
|
|
|
3757
3757
|
export interface AutoMLCandidateGenerationConfig {
|
|
3758
3758
|
/**
|
|
3759
3759
|
* <p>A URL to the Amazon S3 data source containing selected features from the input data source to
|
|
3760
|
-
* run an Autopilot job
|
|
3760
|
+
* run an Autopilot job. You can input <code>FeatureAttributeNames</code> (optional) in JSON
|
|
3761
|
+
* format as shown below: </p>
|
|
3761
3762
|
* <p>
|
|
3762
3763
|
* <code>{ "FeatureAttributeNames":["col1", "col2", ...] }</code>.</p>
|
|
3764
|
+
* <p>You can also specify the data type of the feature (optional) in the format shown
|
|
3765
|
+
* below:</p>
|
|
3766
|
+
* <p>
|
|
3767
|
+
* <code>{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }</code>
|
|
3768
|
+
* </p>
|
|
3769
|
+
* <note>
|
|
3770
|
+
* <p>These column keys may not include the target column.</p>
|
|
3771
|
+
* </note>
|
|
3772
|
+
* <p>In ensembling mode, Autopilot will only support the following data types:
|
|
3773
|
+
* <code>numeric</code>, <code>categorical</code>, <code>text</code> and
|
|
3774
|
+
* <code>datetime</code>. In HPO mode, Autopilot can support <code>numeric</code>,
|
|
3775
|
+
* <code>categorical</code>, <code>text</code>, <code>datetime</code> and
|
|
3776
|
+
* <code>sequence</code>.</p>
|
|
3777
|
+
* <p>If only <code>FeatureDataTypes</code> is provided, the column keys (<code>col1</code>,
|
|
3778
|
+
* <code>col2</code>,..) should be a subset of the column names in the input data. </p>
|
|
3779
|
+
* <p>If both <code>FeatureDataTypes</code> and <code>FeatureAttributeNames</code> are
|
|
3780
|
+
* provided, then the column keys should be a subset of the column names provided in
|
|
3781
|
+
* <code>FeatureAttributeNames</code>. </p>
|
|
3763
3782
|
* <p>The key name <code>FeatureAttributeNames</code> is fixed. The values listed in
|
|
3764
3783
|
* <code>["col1", "col2", ...]</code> is case sensitive and should be a list of strings
|
|
3765
3784
|
* containing unique values that are a subset of the column names in the input data. The list
|
|
@@ -4489,6 +4508,39 @@ export declare enum CandidateSortBy {
|
|
|
4489
4508
|
FinalObjectiveMetricValue = "FinalObjectiveMetricValue",
|
|
4490
4509
|
Status = "Status"
|
|
4491
4510
|
}
|
|
4511
|
+
export declare enum FeatureStatus {
|
|
4512
|
+
Disabled = "DISABLED",
|
|
4513
|
+
Enabled = "ENABLED"
|
|
4514
|
+
}
|
|
4515
|
+
/**
|
|
4516
|
+
* <p>Time series forecast settings for the SageMaker Canvas app.</p>
|
|
4517
|
+
*/
|
|
4518
|
+
export interface TimeSeriesForecastingSettings {
|
|
4519
|
+
/**
|
|
4520
|
+
* <p>Describes whether time series forecasting is enabled or disabled in the Canvas app.</p>
|
|
4521
|
+
*/
|
|
4522
|
+
Status?: FeatureStatus | string;
|
|
4523
|
+
/**
|
|
4524
|
+
* <p>The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default,
|
|
4525
|
+
* Canvas uses the execution role specified in the <code>UserProfile</code> that launches the Canvas app.
|
|
4526
|
+
* If an execution role is not specified in the <code>UserProfile</code>, Canvas uses the execution
|
|
4527
|
+
* role specified in the Domain that owns the <code>UserProfile</code>.
|
|
4528
|
+
* To allow time series forecasting, this IAM role should have the
|
|
4529
|
+
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-canvas.html#security-iam-awsmanpol-AmazonSageMakerCanvasForecastAccess">
|
|
4530
|
+
* AmazonSageMakerCanvasForecastAccess</a> policy attached and <code>forecast.amazonaws.com</code> added
|
|
4531
|
+
* in the trust relationship as a service principal.</p>
|
|
4532
|
+
*/
|
|
4533
|
+
AmazonForecastRoleArn?: string;
|
|
4534
|
+
}
|
|
4535
|
+
/**
|
|
4536
|
+
* <p>The SageMaker Canvas app settings.</p>
|
|
4537
|
+
*/
|
|
4538
|
+
export interface CanvasAppSettings {
|
|
4539
|
+
/**
|
|
4540
|
+
* <p>Time series forecast settings for the Canvas app.</p>
|
|
4541
|
+
*/
|
|
4542
|
+
TimeSeriesForecastingSettings?: TimeSeriesForecastingSettings;
|
|
4543
|
+
}
|
|
4492
4544
|
/**
|
|
4493
4545
|
* <p>Configuration specifying how to treat different headers. If no headers are specified SageMaker
|
|
4494
4546
|
* will by default base64 encode when capturing the data.</p>
|
|
@@ -5517,8 +5569,7 @@ export interface CreateAppRequest {
|
|
|
5517
5569
|
*/
|
|
5518
5570
|
UserProfileName: string | undefined;
|
|
5519
5571
|
/**
|
|
5520
|
-
* <p>The type of app
|
|
5521
|
-
* <code>KernelGateway</code>. <code>TensorBoard</code> is not supported.</p>
|
|
5572
|
+
* <p>The type of app.</p>
|
|
5522
5573
|
*/
|
|
5523
5574
|
AppType: AppType | string | undefined;
|
|
5524
5575
|
/**
|
|
@@ -7204,6 +7255,10 @@ export interface UserSettings {
|
|
|
7204
7255
|
* <p>A collection of settings that configure the <code>RSessionGateway</code> app.</p>
|
|
7205
7256
|
*/
|
|
7206
7257
|
RSessionAppSettings?: RSessionAppSettings;
|
|
7258
|
+
/**
|
|
7259
|
+
* <p>The Canvas app settings.</p>
|
|
7260
|
+
*/
|
|
7261
|
+
CanvasAppSettings?: CanvasAppSettings;
|
|
7207
7262
|
}
|
|
7208
7263
|
export declare enum ExecutionRoleIdentityConfig {
|
|
7209
7264
|
DISABLED = "DISABLED",
|
|
@@ -7249,8 +7304,8 @@ export interface DomainSettings {
|
|
|
7249
7304
|
*/
|
|
7250
7305
|
RStudioServerProDomainSettings?: RStudioServerProDomainSettings;
|
|
7251
7306
|
/**
|
|
7252
|
-
* <p>The configuration for attaching a SageMaker user profile name to the execution role as a
|
|
7253
|
-
*
|
|
7307
|
+
* <p>The configuration for attaching a SageMaker user profile name to the execution role as a
|
|
7308
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">sts:SourceIdentity key</a>.</p>
|
|
7254
7309
|
*/
|
|
7255
7310
|
ExecutionRoleIdentityConfig?: ExecutionRoleIdentityConfig | string;
|
|
7256
7311
|
}
|
|
@@ -7708,23 +7763,20 @@ export interface ProductionVariant {
|
|
|
7708
7763
|
*/
|
|
7709
7764
|
ServerlessConfig?: ProductionVariantServerlessConfig;
|
|
7710
7765
|
/**
|
|
7711
|
-
* <p>The size, in GB, of the ML storage volume attached to individual
|
|
7712
|
-
*
|
|
7713
|
-
*
|
|
7766
|
+
* <p>The size, in GB, of the ML storage volume attached to individual inference instance
|
|
7767
|
+
* associated with the production variant. Currenly only Amazon EBS gp2 storage volumes are
|
|
7768
|
+
* supported.</p>
|
|
7714
7769
|
*/
|
|
7715
7770
|
VolumeSizeInGB?: number;
|
|
7716
7771
|
/**
|
|
7717
|
-
* <p>The timeout value, in seconds, to download and extract the
|
|
7718
|
-
*
|
|
7719
|
-
*
|
|
7772
|
+
* <p>The timeout value, in seconds, to download and extract the model that you want to host
|
|
7773
|
+
* from Amazon S3 to the individual inference instance associated with this production
|
|
7774
|
+
* variant.</p>
|
|
7720
7775
|
*/
|
|
7721
7776
|
ModelDataDownloadTimeoutInSeconds?: number;
|
|
7722
7777
|
/**
|
|
7723
|
-
* <p>The timeout value, in seconds, for your inference container
|
|
7724
|
-
*
|
|
7725
|
-
* check, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests">How
|
|
7726
|
-
* Your Container Should Respond to Health Check (Ping)
|
|
7727
|
-
* Requests</a>.</p>
|
|
7778
|
+
* <p>The timeout value, in seconds, for your inference container to pass health check by
|
|
7779
|
+
* SageMaker Hosting. For more information about health check, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests">How Your Container Should Respond to Health Check (Ping) Requests</a>.</p>
|
|
7728
7780
|
*/
|
|
7729
7781
|
ContainerStartupHealthCheckTimeoutInSeconds?: number;
|
|
7730
7782
|
}
|
|
@@ -8994,62 +9046,6 @@ export interface IntegerParameterRange {
|
|
|
8994
9046
|
*/
|
|
8995
9047
|
ScalingType?: HyperParameterScalingType | string;
|
|
8996
9048
|
}
|
|
8997
|
-
/**
|
|
8998
|
-
* <p>Specifies ranges of integer, continuous, and categorical hyperparameters that a
|
|
8999
|
-
* hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs
|
|
9000
|
-
* with hyperparameter values within these ranges to find the combination of values that
|
|
9001
|
-
* result in the training job with the best performance as measured by the objective metric
|
|
9002
|
-
* of the hyperparameter tuning job.</p>
|
|
9003
|
-
* <note>
|
|
9004
|
-
* <p>The maximum number of items specified for <code>Array Members</code> refers to the
|
|
9005
|
-
* maximum number of hyperparameters for each range and also the maximum for the
|
|
9006
|
-
* hyperparameter tuning job itself. That is, the sum of the number of hyperparameters
|
|
9007
|
-
* for all the ranges can't exceed the maximum number specified.</p>
|
|
9008
|
-
* </note>
|
|
9009
|
-
*/
|
|
9010
|
-
export interface ParameterRanges {
|
|
9011
|
-
/**
|
|
9012
|
-
* <p>The array of <a>IntegerParameterRange</a> objects that specify ranges of
|
|
9013
|
-
* integer hyperparameters that a hyperparameter tuning job searches.</p>
|
|
9014
|
-
*/
|
|
9015
|
-
IntegerParameterRanges?: IntegerParameterRange[];
|
|
9016
|
-
/**
|
|
9017
|
-
* <p>The array of <a>ContinuousParameterRange</a> objects that specify ranges of
|
|
9018
|
-
* continuous hyperparameters that a hyperparameter tuning job searches.</p>
|
|
9019
|
-
*/
|
|
9020
|
-
ContinuousParameterRanges?: ContinuousParameterRange[];
|
|
9021
|
-
/**
|
|
9022
|
-
* <p>The array of <a>CategoricalParameterRange</a> objects that specify ranges
|
|
9023
|
-
* of categorical hyperparameters that a hyperparameter tuning job searches.</p>
|
|
9024
|
-
*/
|
|
9025
|
-
CategoricalParameterRanges?: CategoricalParameterRange[];
|
|
9026
|
-
}
|
|
9027
|
-
/**
|
|
9028
|
-
* <p>Specifies the maximum number of
|
|
9029
|
-
* training
|
|
9030
|
-
* jobs and parallel training jobs that a hyperparameter tuning job can
|
|
9031
|
-
* launch.</p>
|
|
9032
|
-
*/
|
|
9033
|
-
export interface ResourceLimits {
|
|
9034
|
-
/**
|
|
9035
|
-
* <p>The
|
|
9036
|
-
* maximum
|
|
9037
|
-
* number of training jobs that a hyperparameter tuning job can
|
|
9038
|
-
* launch.</p>
|
|
9039
|
-
*/
|
|
9040
|
-
MaxNumberOfTrainingJobs: number | undefined;
|
|
9041
|
-
/**
|
|
9042
|
-
* <p>The
|
|
9043
|
-
* maximum
|
|
9044
|
-
* number of concurrent training jobs that a hyperparameter tuning job can
|
|
9045
|
-
* launch.</p>
|
|
9046
|
-
*/
|
|
9047
|
-
MaxParallelTrainingJobs: number | undefined;
|
|
9048
|
-
}
|
|
9049
|
-
export declare enum HyperParameterTuningJobStrategyType {
|
|
9050
|
-
BAYESIAN = "Bayesian",
|
|
9051
|
-
RANDOM = "Random"
|
|
9052
|
-
}
|
|
9053
9049
|
/**
|
|
9054
9050
|
* @internal
|
|
9055
9051
|
*/
|
|
@@ -9406,6 +9402,14 @@ export declare const OutputParameterFilterSensitiveLog: (obj: OutputParameter) =
|
|
|
9406
9402
|
* @internal
|
|
9407
9403
|
*/
|
|
9408
9404
|
export declare const CallbackStepMetadataFilterSensitiveLog: (obj: CallbackStepMetadata) => any;
|
|
9405
|
+
/**
|
|
9406
|
+
* @internal
|
|
9407
|
+
*/
|
|
9408
|
+
export declare const TimeSeriesForecastingSettingsFilterSensitiveLog: (obj: TimeSeriesForecastingSettings) => any;
|
|
9409
|
+
/**
|
|
9410
|
+
* @internal
|
|
9411
|
+
*/
|
|
9412
|
+
export declare const CanvasAppSettingsFilterSensitiveLog: (obj: CanvasAppSettings) => any;
|
|
9409
9413
|
/**
|
|
9410
9414
|
* @internal
|
|
9411
9415
|
*/
|
|
@@ -9894,11 +9898,3 @@ export declare const CreateHumanTaskUiResponseFilterSensitiveLog: (obj: CreateHu
|
|
|
9894
9898
|
* @internal
|
|
9895
9899
|
*/
|
|
9896
9900
|
export declare const IntegerParameterRangeFilterSensitiveLog: (obj: IntegerParameterRange) => any;
|
|
9897
|
-
/**
|
|
9898
|
-
* @internal
|
|
9899
|
-
*/
|
|
9900
|
-
export declare const ParameterRangesFilterSensitiveLog: (obj: ParameterRanges) => any;
|
|
9901
|
-
/**
|
|
9902
|
-
* @internal
|
|
9903
|
-
*/
|
|
9904
|
-
export declare const ResourceLimitsFilterSensitiveLog: (obj: ResourceLimits) => any;
|
|
@@ -1,4 +1,136 @@
|
|
|
1
|
-
import { ActionSource, ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AlgorithmStatus, AlgorithmStatusDetails, AlgorithmValidationSpecification, AnnotationConsolidationConfig, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, AppStatus, AppType, ArtifactSource, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, AutoMLCandidate, AutoMLChannel, AutoMLJobArtifacts, AutoMLJobCompletionCriteria, AutoMLJobConfig, AutoMLJobObjective, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLOutputDataConfig, AutoMLPartialFailureReason, BatchStrategy, Bias, CaptureStatus, CategoricalParameter, Channel, CheckpointConfig, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, CompilationJobStatus, ContainerDefinition, ContentClassifier, ContextSource, DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DeploymentConfig, DeviceSelectionConfig, DomainSettings, EdgeDeploymentConfig, EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, EndpointInput,
|
|
1
|
+
import { ActionSource, ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AlgorithmStatus, AlgorithmStatusDetails, AlgorithmValidationSpecification, AnnotationConsolidationConfig, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, AppStatus, AppType, ArtifactSource, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, AutoMLCandidate, AutoMLChannel, AutoMLJobArtifacts, AutoMLJobCompletionCriteria, AutoMLJobConfig, AutoMLJobObjective, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLOutputDataConfig, AutoMLPartialFailureReason, BatchStrategy, Bias, CaptureStatus, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, CompilationJobStatus, ContainerDefinition, ContentClassifier, ContextSource, ContinuousParameterRange, DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DeploymentConfig, DeviceSelectionConfig, DomainSettings, EdgeDeploymentConfig, EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, EndpointInput, GitConfig, HyperParameterTuningJobObjective, InferenceSpecification, InputConfig, IntegerParameterRange, KernelGatewayImageConfig, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, ModelDeployConfig, MonitoringConstraintsResource, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStatisticsResource, MonitoringStoppingCondition, NeoVpcConfig, OutputConfig, OutputDataConfig, ProblemType, ProcessingInstanceType, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProcessingS3UploadMode, ProductionVariant, ProductionVariantAcceleratorType, ProductionVariantInstanceType, ProductionVariantServerlessConfig, PublicWorkforceTaskPrice, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TrainingInputMode, TrainingInstanceType, TrainingSpecification, TransformInput, TransformJobDefinition, TransformOutput, TransformResources, UserContext, UserSettings, VpcConfig } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* <p>Specifies ranges of integer, continuous, and categorical hyperparameters that a
|
|
4
|
+
* hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs
|
|
5
|
+
* with hyperparameter values within these ranges to find the combination of values that
|
|
6
|
+
* result in the training job with the best performance as measured by the objective metric
|
|
7
|
+
* of the hyperparameter tuning job.</p>
|
|
8
|
+
* <note>
|
|
9
|
+
* <p>The maximum number of items specified for <code>Array Members</code> refers to the
|
|
10
|
+
* maximum number of hyperparameters for each range and also the maximum for the
|
|
11
|
+
* hyperparameter tuning job itself. That is, the sum of the number of hyperparameters
|
|
12
|
+
* for all the ranges can't exceed the maximum number specified.</p>
|
|
13
|
+
* </note>
|
|
14
|
+
*/
|
|
15
|
+
export interface ParameterRanges {
|
|
16
|
+
/**
|
|
17
|
+
* <p>The array of <a>IntegerParameterRange</a> objects that specify ranges of
|
|
18
|
+
* integer hyperparameters that a hyperparameter tuning job searches.</p>
|
|
19
|
+
*/
|
|
20
|
+
IntegerParameterRanges?: IntegerParameterRange[];
|
|
21
|
+
/**
|
|
22
|
+
* <p>The array of <a>ContinuousParameterRange</a> objects that specify ranges of
|
|
23
|
+
* continuous hyperparameters that a hyperparameter tuning job searches.</p>
|
|
24
|
+
*/
|
|
25
|
+
ContinuousParameterRanges?: ContinuousParameterRange[];
|
|
26
|
+
/**
|
|
27
|
+
* <p>The array of <a>CategoricalParameterRange</a> objects that specify ranges
|
|
28
|
+
* of categorical hyperparameters that a hyperparameter tuning job searches.</p>
|
|
29
|
+
*/
|
|
30
|
+
CategoricalParameterRanges?: CategoricalParameterRange[];
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* <p>Specifies the maximum number of
|
|
34
|
+
* training
|
|
35
|
+
* jobs and parallel training jobs that a hyperparameter tuning job can
|
|
36
|
+
* launch.</p>
|
|
37
|
+
*/
|
|
38
|
+
export interface ResourceLimits {
|
|
39
|
+
/**
|
|
40
|
+
* <p>The
|
|
41
|
+
* maximum
|
|
42
|
+
* number of training jobs that a hyperparameter tuning job can
|
|
43
|
+
* launch.</p>
|
|
44
|
+
*/
|
|
45
|
+
MaxNumberOfTrainingJobs: number | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* <p>The
|
|
48
|
+
* maximum
|
|
49
|
+
* number of concurrent training jobs that a hyperparameter tuning job can
|
|
50
|
+
* launch.</p>
|
|
51
|
+
*/
|
|
52
|
+
MaxParallelTrainingJobs: number | undefined;
|
|
53
|
+
}
|
|
54
|
+
export declare enum HyperParameterTuningJobStrategyType {
|
|
55
|
+
BAYESIAN = "Bayesian",
|
|
56
|
+
HYPERBAND = "Hyperband",
|
|
57
|
+
RANDOM = "Random"
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* <p>The configuration for <code>Hyperband</code>, a multi-fidelity based hyperparameter
|
|
61
|
+
* tuning strategy. <code>Hyperband</code> uses the final and intermediate results of a
|
|
62
|
+
* training job to dynamically allocate resources to utilized hyperparameter configurations
|
|
63
|
+
* while automatically stopping under-performing configurations. This parameter should be
|
|
64
|
+
* provided only if <code>Hyperband</code> is selected as the <code>StrategyConfig</code>
|
|
65
|
+
* under the <code>HyperParameterTuningJobConfig</code> API.</p>
|
|
66
|
+
*/
|
|
67
|
+
export interface HyperbandStrategyConfig {
|
|
68
|
+
/**
|
|
69
|
+
* <p>The minimum number of resources (such as epochs) that can be used by a training job
|
|
70
|
+
* launched by a hyperparameter tuning job. If the value for <code>MinResource</code> has not
|
|
71
|
+
* been reached, the training job will not be stopped by <code>Hyperband</code>.</p>
|
|
72
|
+
*/
|
|
73
|
+
MinResource?: number;
|
|
74
|
+
/**
|
|
75
|
+
* <p>The maximum number of resources (such as epochs) that can be used by a training job
|
|
76
|
+
* launched by a hyperparameter tuning job. Once a job reaches the <code>MaxResource</code>
|
|
77
|
+
* value, it is stopped. If a value for <code>MaxResource</code> is not provided, and
|
|
78
|
+
* <code>Hyperband</code> is selected as the hyperparameter tuning strategy,
|
|
79
|
+
* <code>HyperbandTrainingJ</code> attempts to infer <code>MaxResource</code> from the
|
|
80
|
+
* following keys (if present) in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-StaticHyperParameters">StaticsHyperParameters</a>:</p>
|
|
81
|
+
* <ul>
|
|
82
|
+
* <li>
|
|
83
|
+
* <p>
|
|
84
|
+
* <code>epochs</code>
|
|
85
|
+
* </p>
|
|
86
|
+
* </li>
|
|
87
|
+
* <li>
|
|
88
|
+
* <p>
|
|
89
|
+
* <code>numepochs</code>
|
|
90
|
+
* </p>
|
|
91
|
+
* </li>
|
|
92
|
+
* <li>
|
|
93
|
+
* <p>
|
|
94
|
+
* <code>n-epochs</code>
|
|
95
|
+
* </p>
|
|
96
|
+
* </li>
|
|
97
|
+
* <li>
|
|
98
|
+
* <p>
|
|
99
|
+
* <code>n_epochs</code>
|
|
100
|
+
* </p>
|
|
101
|
+
* </li>
|
|
102
|
+
* <li>
|
|
103
|
+
* <p>
|
|
104
|
+
* <code>num_epochs</code>
|
|
105
|
+
* </p>
|
|
106
|
+
* </li>
|
|
107
|
+
* </ul>
|
|
108
|
+
* <p>If <code>HyperbandStrategyConfig</code> is unable to infer a value for
|
|
109
|
+
* <code>MaxResource</code>, it generates a validation error. The maximum value is 20,000
|
|
110
|
+
* epochs. All metrics that correspond to an objective metric are used to derive <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html">early stopping
|
|
111
|
+
* decisions</a>. For <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/distributed-training.html">distributive</a> training jobs,
|
|
112
|
+
* ensure that duplicate metrics are not printed in the logs across the individual nodes in a
|
|
113
|
+
* training job. If multiple nodes are publishing duplicate or incorrect metrics, training
|
|
114
|
+
* jobs may make an incorrect stopping decision and stop the job prematurely. </p>
|
|
115
|
+
*/
|
|
116
|
+
MaxResource?: number;
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* <p>The configuration for a training job launched by a hyperparameter tuning job. Choose
|
|
120
|
+
* <code>Bayesian</code> for Bayesian optimization, and <code>Random</code> for random
|
|
121
|
+
* search optimization. For more advanced use cases, use <code>Hyperband</code>, which
|
|
122
|
+
* evaluates objective metrics for training jobs after every epoch. For more information about
|
|
123
|
+
* strategies, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html">How Hyperparameter
|
|
124
|
+
* Tuning Works</a>.</p>
|
|
125
|
+
*/
|
|
126
|
+
export interface HyperParameterTuningJobStrategyConfig {
|
|
127
|
+
/**
|
|
128
|
+
* <p>The configuration for the object that specifies the <code>Hyperband</code> strategy.
|
|
129
|
+
* This parameter is only supported for the <code>Hyperband</code> selection for
|
|
130
|
+
* <code>Strategy</code> within the <code>HyperParameterTuningJobConfig</code> API.</p>
|
|
131
|
+
*/
|
|
132
|
+
HyperbandStrategyConfig?: HyperbandStrategyConfig;
|
|
133
|
+
}
|
|
2
134
|
export declare enum TrainingJobEarlyStoppingType {
|
|
3
135
|
AUTO = "Auto",
|
|
4
136
|
OFF = "Off"
|
|
@@ -18,12 +150,17 @@ export interface TuningJobCompletionCriteria {
|
|
|
18
150
|
export interface HyperParameterTuningJobConfig {
|
|
19
151
|
/**
|
|
20
152
|
* <p>Specifies how hyperparameter tuning chooses the combinations of hyperparameter values
|
|
21
|
-
* to use for the training job it launches.
|
|
22
|
-
*
|
|
23
|
-
* information about search strategies, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html">How
|
|
153
|
+
* to use for the training job it launches. For information about search strategies, see
|
|
154
|
+
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html">How
|
|
24
155
|
* Hyperparameter Tuning Works</a>.</p>
|
|
25
156
|
*/
|
|
26
157
|
Strategy: HyperParameterTuningJobStrategyType | string | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* <p>The configuration for the <code>Hyperband</code> optimization strategy. This parameter
|
|
160
|
+
* should be provided only if <code>Hyperband</code> is selected as the strategy for
|
|
161
|
+
* <code>HyperParameterTuningJobConfig</code>.</p>
|
|
162
|
+
*/
|
|
163
|
+
StrategyConfig?: HyperParameterTuningJobStrategyConfig;
|
|
27
164
|
/**
|
|
28
165
|
* <p>The <a>HyperParameterTuningJobObjective</a> object that specifies the
|
|
29
166
|
* objective
|
|
@@ -45,8 +182,10 @@ export interface HyperParameterTuningJobConfig {
|
|
|
45
182
|
ParameterRanges?: ParameterRanges;
|
|
46
183
|
/**
|
|
47
184
|
* <p>Specifies whether to use early stopping for training jobs launched by the
|
|
48
|
-
* hyperparameter tuning job.
|
|
49
|
-
*
|
|
185
|
+
* hyperparameter tuning job. Because the <code>Hyperband</code> strategy has its own
|
|
186
|
+
* advanced internal early stopping mechanism,
|
|
187
|
+
* <code>TrainingJobEarlyStoppingType</code> must be <code>OFF</code> to use <code>Hyperband</code>. This parameter can take on one of the following values (the
|
|
188
|
+
* default value is <code>OFF</code>):</p>
|
|
50
189
|
* <dl>
|
|
51
190
|
* <dt>OFF</dt>
|
|
52
191
|
* <dd>
|
|
@@ -2620,7 +2759,7 @@ export interface HumanTaskConfig {
|
|
|
2620
2759
|
/**
|
|
2621
2760
|
* <p>Defines the maximum number of data objects that can be labeled by human workers at the
|
|
2622
2761
|
* same time. Also referred to as batch size. Each object may have more than one worker at one time.
|
|
2623
|
-
* The default value is 1000 objects.</p>
|
|
2762
|
+
* The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.</p>
|
|
2624
2763
|
*/
|
|
2625
2764
|
MaxConcurrentTaskCount?: number;
|
|
2626
2765
|
/**
|
|
@@ -5098,11 +5237,11 @@ export interface CreateTrainingJobRequest {
|
|
|
5098
5237
|
* key-value pair. Each key and value is limited to 256 characters, as specified by the
|
|
5099
5238
|
* <code>Length Constraint</code>. </p>
|
|
5100
5239
|
* <important>
|
|
5101
|
-
* <p>You must not include any security-sensitive information, such as
|
|
5102
|
-
*
|
|
5103
|
-
*
|
|
5104
|
-
*
|
|
5105
|
-
*
|
|
5240
|
+
* <p>You must not include any security-sensitive information, such as account access
|
|
5241
|
+
* IDs, secrets, and tokens, in the dictionary for configuring hyperparameters. SageMaker
|
|
5242
|
+
* rejects the training job request and returns an exception error for detected
|
|
5243
|
+
* credentials, if such user input is found.</p>
|
|
5244
|
+
* </important>
|
|
5106
5245
|
*/
|
|
5107
5246
|
HyperParameters?: Record<string, string>;
|
|
5108
5247
|
/**
|
|
@@ -5661,13 +5800,13 @@ export interface CreateUserProfileRequest {
|
|
|
5661
5800
|
UserProfileName: string | undefined;
|
|
5662
5801
|
/**
|
|
5663
5802
|
* <p>A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName".
|
|
5664
|
-
* If the Domain's AuthMode is
|
|
5803
|
+
* If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
|
|
5665
5804
|
* </p>
|
|
5666
5805
|
*/
|
|
5667
5806
|
SingleSignOnUserIdentifier?: string;
|
|
5668
5807
|
/**
|
|
5669
|
-
* <p>The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is
|
|
5670
|
-
* required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not
|
|
5808
|
+
* <p>The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is
|
|
5809
|
+
* required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
|
|
5671
5810
|
* </p>
|
|
5672
5811
|
*/
|
|
5673
5812
|
SingleSignOnUserValue?: string;
|
|
@@ -7230,7 +7369,7 @@ export interface DescribeDomainResponse {
|
|
|
7230
7369
|
*/
|
|
7231
7370
|
HomeEfsFileSystemId?: string;
|
|
7232
7371
|
/**
|
|
7233
|
-
* <p>The
|
|
7372
|
+
* <p>The IAM Identity Center managed application instance ID.</p>
|
|
7234
7373
|
*/
|
|
7235
7374
|
SingleSignOnManagedApplicationInstanceId?: string;
|
|
7236
7375
|
/**
|
|
@@ -7923,170 +8062,21 @@ export declare enum OfflineStoreStatusValue {
|
|
|
7923
8062
|
DISABLED = "Disabled"
|
|
7924
8063
|
}
|
|
7925
8064
|
/**
|
|
7926
|
-
*
|
|
8065
|
+
* @internal
|
|
7927
8066
|
*/
|
|
7928
|
-
export
|
|
7929
|
-
/**
|
|
7930
|
-
* <p>An <code>OfflineStore</code> status.</p>
|
|
7931
|
-
*/
|
|
7932
|
-
Status: OfflineStoreStatusValue | string | undefined;
|
|
7933
|
-
/**
|
|
7934
|
-
* <p>The justification for why the OfflineStoreStatus is Blocked (if applicable).</p>
|
|
7935
|
-
*/
|
|
7936
|
-
BlockedReason?: string;
|
|
7937
|
-
}
|
|
7938
|
-
export interface DescribeFeatureGroupResponse {
|
|
7939
|
-
/**
|
|
7940
|
-
* <p>The Amazon Resource Name (ARN) of the <code>FeatureGroup</code>. </p>
|
|
7941
|
-
*/
|
|
7942
|
-
FeatureGroupArn: string | undefined;
|
|
7943
|
-
/**
|
|
7944
|
-
* <p>he name of the <code>FeatureGroup</code>.</p>
|
|
7945
|
-
*/
|
|
7946
|
-
FeatureGroupName: string | undefined;
|
|
7947
|
-
/**
|
|
7948
|
-
* <p>The name of the <code>Feature</code> used for <code>RecordIdentifier</code>, whose value
|
|
7949
|
-
* uniquely identifies a record stored in the feature store.</p>
|
|
7950
|
-
*/
|
|
7951
|
-
RecordIdentifierFeatureName: string | undefined;
|
|
7952
|
-
/**
|
|
7953
|
-
* <p>The name of the feature that stores the <code>EventTime</code> of a Record in a
|
|
7954
|
-
* <code>FeatureGroup</code>.</p>
|
|
7955
|
-
* <p> An <code>EventTime</code> is a point in time when a new event occurs that
|
|
7956
|
-
* corresponds to the creation or update of a <code>Record</code> in a
|
|
7957
|
-
* <code>FeatureGroup</code>. All <code>Records</code> in the <code>FeatureGroup</code>
|
|
7958
|
-
* have a corresponding <code>EventTime</code>.</p>
|
|
7959
|
-
*/
|
|
7960
|
-
EventTimeFeatureName: string | undefined;
|
|
7961
|
-
/**
|
|
7962
|
-
* <p>A list of the <code>Features</code> in the <code>FeatureGroup</code>.
|
|
7963
|
-
* Each feature is defined by a <code>FeatureName</code> and <code>FeatureType</code>.</p>
|
|
7964
|
-
*/
|
|
7965
|
-
FeatureDefinitions: FeatureDefinition[] | undefined;
|
|
7966
|
-
/**
|
|
7967
|
-
* <p>A timestamp indicating when SageMaker created the <code>FeatureGroup</code>.</p>
|
|
7968
|
-
*/
|
|
7969
|
-
CreationTime: Date | undefined;
|
|
7970
|
-
/**
|
|
7971
|
-
* <p>A timestamp indicating when the feature group was last updated.</p>
|
|
7972
|
-
*/
|
|
7973
|
-
LastModifiedTime?: Date;
|
|
7974
|
-
/**
|
|
7975
|
-
* <p>The configuration for the <code>OnlineStore</code>.</p>
|
|
7976
|
-
*/
|
|
7977
|
-
OnlineStoreConfig?: OnlineStoreConfig;
|
|
7978
|
-
/**
|
|
7979
|
-
* <p>The configuration of the <code>OfflineStore</code>, inducing the S3 location of the
|
|
7980
|
-
* <code>OfflineStore</code>, Amazon Web Services Glue or Amazon Web Services Hive data catalogue configurations, and the
|
|
7981
|
-
* security configuration.</p>
|
|
7982
|
-
*/
|
|
7983
|
-
OfflineStoreConfig?: OfflineStoreConfig;
|
|
7984
|
-
/**
|
|
7985
|
-
* <p>The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the
|
|
7986
|
-
* <code>OfflineStore</code> if an <code>OfflineStoreConfig</code> is provided.</p>
|
|
7987
|
-
*/
|
|
7988
|
-
RoleArn?: string;
|
|
7989
|
-
/**
|
|
7990
|
-
* <p>The status of the feature group.</p>
|
|
7991
|
-
*/
|
|
7992
|
-
FeatureGroupStatus?: FeatureGroupStatus | string;
|
|
7993
|
-
/**
|
|
7994
|
-
* <p>The status of the <code>OfflineStore</code>. Notifies you if replicating data into the
|
|
7995
|
-
* <code>OfflineStore</code> has failed. Returns either: <code>Active</code> or
|
|
7996
|
-
* <code>Blocked</code>
|
|
7997
|
-
* </p>
|
|
7998
|
-
*/
|
|
7999
|
-
OfflineStoreStatus?: OfflineStoreStatus;
|
|
8000
|
-
/**
|
|
8001
|
-
* <p>A value indicating whether the update made to the feature group was successful.</p>
|
|
8002
|
-
*/
|
|
8003
|
-
LastUpdateStatus?: LastUpdateStatus;
|
|
8004
|
-
/**
|
|
8005
|
-
* <p>The reason that the <code>FeatureGroup</code> failed to be replicated in the
|
|
8006
|
-
* <code>OfflineStore</code>. This is failure can occur because:</p>
|
|
8007
|
-
* <ul>
|
|
8008
|
-
* <li>
|
|
8009
|
-
* <p>The <code>FeatureGroup</code> could not be created in the
|
|
8010
|
-
* <code>OfflineStore</code>.</p>
|
|
8011
|
-
* </li>
|
|
8012
|
-
* <li>
|
|
8013
|
-
* <p>The <code>FeatureGroup</code> could not be deleted from the
|
|
8014
|
-
* <code>OfflineStore</code>.</p>
|
|
8015
|
-
* </li>
|
|
8016
|
-
* </ul>
|
|
8017
|
-
*/
|
|
8018
|
-
FailureReason?: string;
|
|
8019
|
-
/**
|
|
8020
|
-
* <p>A free form description of the feature group.</p>
|
|
8021
|
-
*/
|
|
8022
|
-
Description?: string;
|
|
8023
|
-
/**
|
|
8024
|
-
* <p>A token to resume pagination of the list of <code>Features</code>
|
|
8025
|
-
* (<code>FeatureDefinitions</code>).</p>
|
|
8026
|
-
*/
|
|
8027
|
-
NextToken: string | undefined;
|
|
8028
|
-
/**
|
|
8029
|
-
* <p>The size of the <code>OnlineStore</code> in bytes.</p>
|
|
8030
|
-
*/
|
|
8031
|
-
OnlineStoreTotalSizeBytes?: number;
|
|
8032
|
-
}
|
|
8033
|
-
export interface DescribeFeatureMetadataRequest {
|
|
8034
|
-
/**
|
|
8035
|
-
* <p>The name of the feature group containing the feature.</p>
|
|
8036
|
-
*/
|
|
8037
|
-
FeatureGroupName: string | undefined;
|
|
8038
|
-
/**
|
|
8039
|
-
* <p>The name of the feature.</p>
|
|
8040
|
-
*/
|
|
8041
|
-
FeatureName: string | undefined;
|
|
8042
|
-
}
|
|
8067
|
+
export declare const ParameterRangesFilterSensitiveLog: (obj: ParameterRanges) => any;
|
|
8043
8068
|
/**
|
|
8044
|
-
*
|
|
8069
|
+
* @internal
|
|
8045
8070
|
*/
|
|
8046
|
-
export
|
|
8047
|
-
|
|
8048
|
-
|
|
8049
|
-
|
|
8050
|
-
|
|
8051
|
-
|
|
8052
|
-
|
|
8053
|
-
|
|
8054
|
-
|
|
8055
|
-
}
|
|
8056
|
-
export interface DescribeFeatureMetadataResponse {
|
|
8057
|
-
/**
|
|
8058
|
-
* <p>The Amazon Resource Number (ARN) of the feature group that contains the feature.</p>
|
|
8059
|
-
*/
|
|
8060
|
-
FeatureGroupArn: string | undefined;
|
|
8061
|
-
/**
|
|
8062
|
-
* <p>The name of the feature group that you've specified.</p>
|
|
8063
|
-
*/
|
|
8064
|
-
FeatureGroupName: string | undefined;
|
|
8065
|
-
/**
|
|
8066
|
-
* <p>The name of the feature that you've specified.</p>
|
|
8067
|
-
*/
|
|
8068
|
-
FeatureName: string | undefined;
|
|
8069
|
-
/**
|
|
8070
|
-
* <p>The data type of the feature.</p>
|
|
8071
|
-
*/
|
|
8072
|
-
FeatureType: FeatureType | string | undefined;
|
|
8073
|
-
/**
|
|
8074
|
-
* <p>A timestamp indicating when the feature was created.</p>
|
|
8075
|
-
*/
|
|
8076
|
-
CreationTime: Date | undefined;
|
|
8077
|
-
/**
|
|
8078
|
-
* <p>A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you </p>
|
|
8079
|
-
*/
|
|
8080
|
-
LastModifiedTime: Date | undefined;
|
|
8081
|
-
/**
|
|
8082
|
-
* <p>The description you added to describe the feature.</p>
|
|
8083
|
-
*/
|
|
8084
|
-
Description?: string;
|
|
8085
|
-
/**
|
|
8086
|
-
* <p>The key-value pairs that you added to describe the feature.</p>
|
|
8087
|
-
*/
|
|
8088
|
-
Parameters?: FeatureParameter[];
|
|
8089
|
-
}
|
|
8071
|
+
export declare const ResourceLimitsFilterSensitiveLog: (obj: ResourceLimits) => any;
|
|
8072
|
+
/**
|
|
8073
|
+
* @internal
|
|
8074
|
+
*/
|
|
8075
|
+
export declare const HyperbandStrategyConfigFilterSensitiveLog: (obj: HyperbandStrategyConfig) => any;
|
|
8076
|
+
/**
|
|
8077
|
+
* @internal
|
|
8078
|
+
*/
|
|
8079
|
+
export declare const HyperParameterTuningJobStrategyConfigFilterSensitiveLog: (obj: HyperParameterTuningJobStrategyConfig) => any;
|
|
8090
8080
|
/**
|
|
8091
8081
|
* @internal
|
|
8092
8082
|
*/
|
|
@@ -9139,23 +9129,3 @@ export declare const DescribeFeatureGroupRequestFilterSensitiveLog: (obj: Descri
|
|
|
9139
9129
|
* @internal
|
|
9140
9130
|
*/
|
|
9141
9131
|
export declare const LastUpdateStatusFilterSensitiveLog: (obj: LastUpdateStatus) => any;
|
|
9142
|
-
/**
|
|
9143
|
-
* @internal
|
|
9144
|
-
*/
|
|
9145
|
-
export declare const OfflineStoreStatusFilterSensitiveLog: (obj: OfflineStoreStatus) => any;
|
|
9146
|
-
/**
|
|
9147
|
-
* @internal
|
|
9148
|
-
*/
|
|
9149
|
-
export declare const DescribeFeatureGroupResponseFilterSensitiveLog: (obj: DescribeFeatureGroupResponse) => any;
|
|
9150
|
-
/**
|
|
9151
|
-
* @internal
|
|
9152
|
-
*/
|
|
9153
|
-
export declare const DescribeFeatureMetadataRequestFilterSensitiveLog: (obj: DescribeFeatureMetadataRequest) => any;
|
|
9154
|
-
/**
|
|
9155
|
-
* @internal
|
|
9156
|
-
*/
|
|
9157
|
-
export declare const FeatureParameterFilterSensitiveLog: (obj: FeatureParameter) => any;
|
|
9158
|
-
/**
|
|
9159
|
-
* @internal
|
|
9160
|
-
*/
|
|
9161
|
-
export declare const DescribeFeatureMetadataResponseFilterSensitiveLog: (obj: DescribeFeatureMetadataResponse) => any;
|