aws-sdk-sagemaker 1.141.0 → 1.143.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -622,6 +622,7 @@ module Aws::SageMaker
622
622
  # instance_group_name: "InstanceGroupName", # required
623
623
  # },
624
624
  # ],
625
+ # keep_alive_period_in_seconds: 1,
625
626
  # },
626
627
  # stopping_condition: { # required
627
628
  # max_runtime_in_seconds: 1,
@@ -744,6 +745,7 @@ module Aws::SageMaker
744
745
  # instance_group_name: "InstanceGroupName", # required
745
746
  # },
746
747
  # ],
748
+ # keep_alive_period_in_seconds: 1,
747
749
  # },
748
750
  # stopping_condition: { # required
749
751
  # max_runtime_in_seconds: 1,
@@ -3461,6 +3463,424 @@ module Aws::SageMaker
3461
3463
  include Aws::Structure
3462
3464
  end
3463
3465
 
3466
+ # The configuration parameters for the SageMaker Clarify explainer.
3467
+ #
3468
+ # @note When making an API call, you may pass ClarifyExplainerConfig
3469
+ # data as a hash:
3470
+ #
3471
+ # {
3472
+ # enable_explanations: "ClarifyEnableExplanations",
3473
+ # inference_config: {
3474
+ # features_attribute: "ClarifyFeaturesAttribute",
3475
+ # content_template: "ClarifyContentTemplate",
3476
+ # max_record_count: 1,
3477
+ # max_payload_in_mb: 1,
3478
+ # probability_index: 1,
3479
+ # label_index: 1,
3480
+ # probability_attribute: "ClarifyProbabilityAttribute",
3481
+ # label_attribute: "ClarifyLabelAttribute",
3482
+ # label_headers: ["ClarifyHeader"],
3483
+ # feature_headers: ["ClarifyHeader"],
3484
+ # feature_types: ["numerical"], # accepts numerical, categorical, text
3485
+ # },
3486
+ # shap_config: { # required
3487
+ # shap_baseline_config: { # required
3488
+ # mime_type: "ClarifyMimeType",
3489
+ # shap_baseline: "ClarifyShapBaseline",
3490
+ # shap_baseline_uri: "Url",
3491
+ # },
3492
+ # number_of_samples: 1,
3493
+ # use_logit: false,
3494
+ # seed: 1,
3495
+ # text_config: {
3496
+ # language: "af", # required, accepts af, sq, ar, hy, eu, bn, bg, ca, zh, hr, cs, da, nl, en, et, fi, fr, de, el, gu, he, hi, hu, is, id, ga, it, kn, ky, lv, lt, lb, mk, ml, mr, ne, nb, fa, pl, pt, ro, ru, sa, sr, tn, si, sk, sl, es, sv, tl, ta, tt, te, tr, uk, ur, yo, lij, xx
3497
+ # granularity: "token", # required, accepts token, sentence, paragraph
3498
+ # },
3499
+ # },
3500
+ # }
3501
+ #
3502
+ # @!attribute [rw] enable_explanations
3503
+ # A JMESPath boolean expression used to filter which records to
3504
+ # explain. Explanations are activated by default. See [
3505
+ # `EnableExplanations` ][1]for additional information.
3506
+ #
3507
+ #
3508
+ #
3509
+ # [1]: https://docs.aws.amazon.com/sagemaker-dg/src/AWSIronmanApiDoc/build/server-root/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable
3510
+ # @return [String]
3511
+ #
3512
+ # @!attribute [rw] inference_config
3513
+ # The inference configuration parameter for the model container.
3514
+ # @return [Types::ClarifyInferenceConfig]
3515
+ #
3516
+ # @!attribute [rw] shap_config
3517
+ # The configuration for SHAP analysis.
3518
+ # @return [Types::ClarifyShapConfig]
3519
+ #
3520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ClarifyExplainerConfig AWS API Documentation
3521
+ #
3522
+ class ClarifyExplainerConfig < Struct.new(
3523
+ :enable_explanations,
3524
+ :inference_config,
3525
+ :shap_config)
3526
+ SENSITIVE = []
3527
+ include Aws::Structure
3528
+ end
3529
+
3530
+ # The inference configuration parameter for the model container.
3531
+ #
3532
+ # @note When making an API call, you may pass ClarifyInferenceConfig
3533
+ # data as a hash:
3534
+ #
3535
+ # {
3536
+ # features_attribute: "ClarifyFeaturesAttribute",
3537
+ # content_template: "ClarifyContentTemplate",
3538
+ # max_record_count: 1,
3539
+ # max_payload_in_mb: 1,
3540
+ # probability_index: 1,
3541
+ # label_index: 1,
3542
+ # probability_attribute: "ClarifyProbabilityAttribute",
3543
+ # label_attribute: "ClarifyLabelAttribute",
3544
+ # label_headers: ["ClarifyHeader"],
3545
+ # feature_headers: ["ClarifyHeader"],
3546
+ # feature_types: ["numerical"], # accepts numerical, categorical, text
3547
+ # }
3548
+ #
3549
+ # @!attribute [rw] features_attribute
3550
+ # Provides the JMESPath expression to extract the features from a
3551
+ # model container input in JSON Lines format. For example, if
3552
+ # `FeaturesAttribute` is the JMESPath expression `'myfeatures'`, it
3553
+ # extracts a list of features `[1,2,3]` from request data
3554
+ # `'\{"myfeatures":[1,2,3\}'`.
3555
+ # @return [String]
3556
+ #
3557
+ # @!attribute [rw] content_template
3558
+ # A template string used to format a JSON record into an acceptable
3559
+ # model container input. For example, a `ContentTemplate` string
3560
+ # `'\{"myfeatures":$features\}'` will format a list of features
3561
+ # `[1,2,3]` into the record string `'\{"myfeatures":[1,2,3]\}'`.
3562
+ # Required only when the model container input is in JSON Lines
3563
+ # format.
3564
+ # @return [String]
3565
+ #
3566
+ # @!attribute [rw] max_record_count
3567
+ # The maximum number of records in a request that the model container
3568
+ # can process when querying the model container for the predictions of
3569
+ # a [synthetic dataset][1]. A record is a unit of input data that
3570
+ # inference can be made on, for example, a single line in CSV data. If
3571
+ # `MaxRecordCount` is `1`, the model container expects one record per
3572
+ # request. A value of 2 or greater means that the model expects batch
3573
+ # requests, which can reduce overhead and speed up the inferencing
3574
+ # process. If this parameter is not provided, the explainer will tune
3575
+ # the record count per request according to the model container's
3576
+ # capacity at runtime.
3577
+ #
3578
+ #
3579
+ #
3580
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-synthetic
3581
+ # @return [Integer]
3582
+ #
3583
+ # @!attribute [rw] max_payload_in_mb
3584
+ # The maximum payload size (MB) allowed of a request from the
3585
+ # explainer to the model container. Defaults to `6` MB.
3586
+ # @return [Integer]
3587
+ #
3588
+ # @!attribute [rw] probability_index
3589
+ # A zero-based index used to extract a probability value (score) or
3590
+ # list from model container output in CSV format. If this value is not
3591
+ # provided, the entire model container output will be treated as a
3592
+ # probability value (score) or list.
3593
+ #
3594
+ # **Example for a single class model:** If the model container output
3595
+ # consists of a string-formatted prediction label followed by its
3596
+ # probability: `'1,0.6'`, set `ProbabilityIndex` to `1` to select the
3597
+ # probability value `0.6`.
3598
+ #
3599
+ # **Example for a multiclass model:** If the model container output
3600
+ # consists of a string-formatted prediction label followed by its
3601
+ # probability: `'"['cat','dog','fish']","[0.1,0.6,0.3]"'`, set
3602
+ # `ProbabilityIndex` to `1` to select the probability values
3603
+ # `[0.1,0.6,0.3]`.
3604
+ # @return [Integer]
3605
+ #
3606
+ # @!attribute [rw] label_index
3607
+ # A zero-based index used to extract a label header or list of label
3608
+ # headers from model container output in CSV format.
3609
+ #
3610
+ # **Example for a multiclass model:** If the model container output
3611
+ # consists of label headers followed by probabilities:
3612
+ # `'"['cat','dog','fish']","[0.1,0.6,0.3]"'`, set `LabelIndex`
3613
+ # to `0` to select the label headers `['cat','dog','fish']`.
3614
+ # @return [Integer]
3615
+ #
3616
+ # @!attribute [rw] probability_attribute
3617
+ # A JMESPath expression used to extract the probability (or score)
3618
+ # from the model container output if the model container is in JSON
3619
+ # Lines format.
3620
+ #
3621
+ # **Example**\: If the model container output of a single request is
3622
+ # `'\{"predicted_label":1,"probability":0.6\}'`, then set
3623
+ # `ProbabilityAttribute` to `'probability'`.
3624
+ # @return [String]
3625
+ #
3626
+ # @!attribute [rw] label_attribute
3627
+ # A JMESPath expression used to locate the list of label headers in
3628
+ # the model container output.
3629
+ #
3630
+ # **Example**\: If the model container output of a batch request is
3631
+ # `'\{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]\}'`,
3632
+ # then set `LabelAttribute` to `'labels'` to extract the list of label
3633
+ # headers `["cat","dog","fish"]`
3634
+ # @return [String]
3635
+ #
3636
+ # @!attribute [rw] label_headers
3637
+ # For multiclass classification problems, the label headers are the
3638
+ # names of the classes. Otherwise, the label header is the name of the
3639
+ # predicted label. These are used to help readability for the output
3640
+ # of the `InvokeEndpoint` API. See the [response][1] section under
3641
+ # **Invoke the endpoint** in the Developer Guide for more information.
3642
+ # If there are no label headers in the model container output, provide
3643
+ # them manually using this parameter.
3644
+ #
3645
+ #
3646
+ #
3647
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response
3648
+ # @return [Array<String>]
3649
+ #
3650
+ # @!attribute [rw] feature_headers
3651
+ # The names of the features. If provided, these are included in the
3652
+ # endpoint response payload to help readability of the
3653
+ # `InvokeEndpoint` output. See the [Response][1] section under
3654
+ # **Invoke the endpoint** in the Developer Guide for more information.
3655
+ #
3656
+ #
3657
+ #
3658
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response
3659
+ # @return [Array<String>]
3660
+ #
3661
+ # @!attribute [rw] feature_types
3662
+ # A list of data types of the features (optional). Applicable only to
3663
+ # NLP explainability. If provided, `FeatureTypes` must have at least
3664
+ # one `'text'` string (for example, `['text']`). If `FeatureTypes` is
3665
+ # not provided, the explainer infers the feature types based on the
3666
+ # baseline data. The feature types are included in the endpoint
3667
+ # response payload. For additional information see the [response][1]
3668
+ # section under **Invoke the endpoint** in the Developer Guide for
3669
+ # more information.
3670
+ #
3671
+ #
3672
+ #
3673
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response
3674
+ # @return [Array<String>]
3675
+ #
3676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ClarifyInferenceConfig AWS API Documentation
3677
+ #
3678
+ class ClarifyInferenceConfig < Struct.new(
3679
+ :features_attribute,
3680
+ :content_template,
3681
+ :max_record_count,
3682
+ :max_payload_in_mb,
3683
+ :probability_index,
3684
+ :label_index,
3685
+ :probability_attribute,
3686
+ :label_attribute,
3687
+ :label_headers,
3688
+ :feature_headers,
3689
+ :feature_types)
3690
+ SENSITIVE = []
3691
+ include Aws::Structure
3692
+ end
3693
+
3694
+ # The configuration for the [SHAP baseline][1] (also called the
3695
+ # background or reference dataset) of the Kernal SHAP algorithm.
3696
+ #
3697
+ # <note markdown="1"> * The number of records in the baseline data determines the size of
3698
+ # the synthetic dataset, which has an impact on latency of
3699
+ # explainability requests. For more information, see the **Synthetic
3700
+ # data** of [Configure and create an endpoint][2].
3701
+ #
3702
+ # * `ShapBaseline` and `ShapBaselineUri` are mutually exclusive
3703
+ # parameters. One or the either is required to configure a SHAP
3704
+ # baseline.
3705
+ #
3706
+ # </note>
3707
+ #
3708
+ #
3709
+ #
3710
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-feature-attribute-shap-baselines.html
3711
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html
3712
+ #
3713
+ # @note When making an API call, you may pass ClarifyShapBaselineConfig
3714
+ # data as a hash:
3715
+ #
3716
+ # {
3717
+ # mime_type: "ClarifyMimeType",
3718
+ # shap_baseline: "ClarifyShapBaseline",
3719
+ # shap_baseline_uri: "Url",
3720
+ # }
3721
+ #
3722
+ # @!attribute [rw] mime_type
3723
+ # The MIME type of the baseline data. Choose from `'text/csv'` or
3724
+ # `'application/jsonlines'`. Defaults to `'text/csv'`.
3725
+ # @return [String]
3726
+ #
3727
+ # @!attribute [rw] shap_baseline
3728
+ # The inline SHAP baseline data in string format. `ShapBaseline` can
3729
+ # have one or multiple records to be used as the baseline dataset. The
3730
+ # format of the SHAP baseline file should be the same format as the
3731
+ # training dataset. For example, if the training dataset is in CSV
3732
+ # format and each record contains four features, and all features are
3733
+ # numerical, then the format of the baseline data should also share
3734
+ # these characteristics. For natural language processing (NLP) of text
3735
+ # columns, the baseline value should be the value used to replace the
3736
+ # unit of text specified by the `Granularity` of the `TextConfig`
3737
+ # parameter. The size limit for `ShapBasline` is 4 KB. Use the
3738
+ # `ShapBaselineUri` parameter if you want to provide more than 4 KB of
3739
+ # baseline data.
3740
+ # @return [String]
3741
+ #
3742
+ # @!attribute [rw] shap_baseline_uri
3743
+ # The uniform resource identifier (URI) of the S3 bucket where the
3744
+ # SHAP baseline file is stored. The format of the SHAP baseline file
3745
+ # should be the same format as the format of the training dataset. For
3746
+ # example, if the training dataset is in CSV format, and each record
3747
+ # in the training dataset has four features, and all features are
3748
+ # numerical, then the baseline file should also have this same format.
3749
+ # Each record should contain only the features. If you are using a
3750
+ # virtual private cloud (VPC), the `ShapBaselineUri` should be
3751
+ # accessible to the VPC. For more information about setting up
3752
+ # endpoints with Amazon Virtual Private Cloud, see [Give SageMaker
3753
+ # access to Resources in your Amazon Virtual Private Cloud][1].
3754
+ #
3755
+ #
3756
+ #
3757
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html
3758
+ # @return [String]
3759
+ #
3760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ClarifyShapBaselineConfig AWS API Documentation
3761
+ #
3762
+ class ClarifyShapBaselineConfig < Struct.new(
3763
+ :mime_type,
3764
+ :shap_baseline,
3765
+ :shap_baseline_uri)
3766
+ SENSITIVE = []
3767
+ include Aws::Structure
3768
+ end
3769
+
3770
+ # The configuration for SHAP analysis using SageMaker Clarify Explainer.
3771
+ #
3772
+ # @note When making an API call, you may pass ClarifyShapConfig
3773
+ # data as a hash:
3774
+ #
3775
+ # {
3776
+ # shap_baseline_config: { # required
3777
+ # mime_type: "ClarifyMimeType",
3778
+ # shap_baseline: "ClarifyShapBaseline",
3779
+ # shap_baseline_uri: "Url",
3780
+ # },
3781
+ # number_of_samples: 1,
3782
+ # use_logit: false,
3783
+ # seed: 1,
3784
+ # text_config: {
3785
+ # language: "af", # required, accepts af, sq, ar, hy, eu, bn, bg, ca, zh, hr, cs, da, nl, en, et, fi, fr, de, el, gu, he, hi, hu, is, id, ga, it, kn, ky, lv, lt, lb, mk, ml, mr, ne, nb, fa, pl, pt, ro, ru, sa, sr, tn, si, sk, sl, es, sv, tl, ta, tt, te, tr, uk, ur, yo, lij, xx
3786
+ # granularity: "token", # required, accepts token, sentence, paragraph
3787
+ # },
3788
+ # }
3789
+ #
3790
+ # @!attribute [rw] shap_baseline_config
3791
+ # The configuration for the SHAP baseline of the Kernal SHAP
3792
+ # algorithm.
3793
+ # @return [Types::ClarifyShapBaselineConfig]
3794
+ #
3795
+ # @!attribute [rw] number_of_samples
3796
+ # The number of samples to be used for analysis by the Kernal SHAP
3797
+ # algorithm.
3798
+ #
3799
+ # <note markdown="1"> The number of samples determines the size of the synthetic dataset,
3800
+ # which has an impact on latency of explainability requests. For more
3801
+ # information, see the **Synthetic data** of [Configure and create an
3802
+ # endpoint][1].
3803
+ #
3804
+ # </note>
3805
+ #
3806
+ #
3807
+ #
3808
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html
3809
+ # @return [Integer]
3810
+ #
3811
+ # @!attribute [rw] use_logit
3812
+ # A Boolean toggle to indicate if you want to use the logit function
3813
+ # (true) or log-odds units (false) for model predictions. Defaults to
3814
+ # false.
3815
+ # @return [Boolean]
3816
+ #
3817
+ # @!attribute [rw] seed
3818
+ # The starting value used to initialize the random number generator in
3819
+ # the explainer. Provide a value for this parameter to obtain a
3820
+ # deterministic SHAP result.
3821
+ # @return [Integer]
3822
+ #
3823
+ # @!attribute [rw] text_config
3824
+ # A parameter that indicates if text features are treated as text and
3825
+ # explanations are provided for individual units of text. Required for
3826
+ # natural language processing (NLP) explainability only.
3827
+ # @return [Types::ClarifyTextConfig]
3828
+ #
3829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ClarifyShapConfig AWS API Documentation
3830
+ #
3831
+ class ClarifyShapConfig < Struct.new(
3832
+ :shap_baseline_config,
3833
+ :number_of_samples,
3834
+ :use_logit,
3835
+ :seed,
3836
+ :text_config)
3837
+ SENSITIVE = []
3838
+ include Aws::Structure
3839
+ end
3840
+
3841
+ # A parameter used to configure the SageMaker Clarify explainer to treat
3842
+ # text features as text so that explanations are provided for individual
3843
+ # units of text. Required only for natural language processing (NLP)
3844
+ # explainability.
3845
+ #
3846
+ # @note When making an API call, you may pass ClarifyTextConfig
3847
+ # data as a hash:
3848
+ #
3849
+ # {
3850
+ # language: "af", # required, accepts af, sq, ar, hy, eu, bn, bg, ca, zh, hr, cs, da, nl, en, et, fi, fr, de, el, gu, he, hi, hu, is, id, ga, it, kn, ky, lv, lt, lb, mk, ml, mr, ne, nb, fa, pl, pt, ro, ru, sa, sr, tn, si, sk, sl, es, sv, tl, ta, tt, te, tr, uk, ur, yo, lij, xx
3851
+ # granularity: "token", # required, accepts token, sentence, paragraph
3852
+ # }
3853
+ #
3854
+ # @!attribute [rw] language
3855
+ # Specifies the language of the text features in [ISO 639-1](
3856
+ # https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or [ISO
3857
+ # 639-3][1] code of a supported language.
3858
+ #
3859
+ # <note markdown="1"> For a mix of multiple languages, use code `'xx'`.
3860
+ #
3861
+ # </note>
3862
+ #
3863
+ #
3864
+ #
3865
+ # [1]: https://en.wikipedia.org/wiki/ISO_639-3
3866
+ # @return [String]
3867
+ #
3868
+ # @!attribute [rw] granularity
3869
+ # The unit of granularity for the analysis of text features. For
3870
+ # example, if the unit is `'token'`, then each token (like a word in
3871
+ # English) of the text is treated as a feature. SHAP values are
3872
+ # computed for each unit/feature.
3873
+ # @return [String]
3874
+ #
3875
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ClarifyTextConfig AWS API Documentation
3876
+ #
3877
+ class ClarifyTextConfig < Struct.new(
3878
+ :language,
3879
+ :granularity)
3880
+ SENSITIVE = []
3881
+ include Aws::Structure
3882
+ end
3883
+
3464
3884
  # Specifies summary information about a Git repository.
3465
3885
  #
3466
3886
  # @!attribute [rw] code_repository_name
@@ -4250,6 +4670,7 @@ module Aws::SageMaker
4250
4670
  # instance_group_name: "InstanceGroupName", # required
4251
4671
  # },
4252
4672
  # ],
4673
+ # keep_alive_period_in_seconds: 1,
4253
4674
  # },
4254
4675
  # stopping_condition: { # required
4255
4676
  # max_runtime_in_seconds: 1,
@@ -5739,6 +6160,38 @@ module Aws::SageMaker
5739
6160
  # },
5740
6161
  # },
5741
6162
  # },
6163
+ # explainer_config: {
6164
+ # clarify_explainer_config: {
6165
+ # enable_explanations: "ClarifyEnableExplanations",
6166
+ # inference_config: {
6167
+ # features_attribute: "ClarifyFeaturesAttribute",
6168
+ # content_template: "ClarifyContentTemplate",
6169
+ # max_record_count: 1,
6170
+ # max_payload_in_mb: 1,
6171
+ # probability_index: 1,
6172
+ # label_index: 1,
6173
+ # probability_attribute: "ClarifyProbabilityAttribute",
6174
+ # label_attribute: "ClarifyLabelAttribute",
6175
+ # label_headers: ["ClarifyHeader"],
6176
+ # feature_headers: ["ClarifyHeader"],
6177
+ # feature_types: ["numerical"], # accepts numerical, categorical, text
6178
+ # },
6179
+ # shap_config: { # required
6180
+ # shap_baseline_config: { # required
6181
+ # mime_type: "ClarifyMimeType",
6182
+ # shap_baseline: "ClarifyShapBaseline",
6183
+ # shap_baseline_uri: "Url",
6184
+ # },
6185
+ # number_of_samples: 1,
6186
+ # use_logit: false,
6187
+ # seed: 1,
6188
+ # text_config: {
6189
+ # language: "af", # required, accepts af, sq, ar, hy, eu, bn, bg, ca, zh, hr, cs, da, nl, en, et, fi, fr, de, el, gu, he, hi, hu, is, id, ga, it, kn, ky, lv, lt, lb, mk, ml, mr, ne, nb, fa, pl, pt, ro, ru, sa, sr, tn, si, sk, sl, es, sv, tl, ta, tt, te, tr, uk, ur, yo, lij, xx
6190
+ # granularity: "token", # required, accepts token, sentence, paragraph
6191
+ # },
6192
+ # },
6193
+ # },
6194
+ # },
5742
6195
  # }
5743
6196
  #
5744
6197
  # @!attribute [rw] endpoint_config_name
@@ -5824,6 +6277,10 @@ module Aws::SageMaker
5824
6277
  # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpointAsync.html
5825
6278
  # @return [Types::AsyncInferenceConfig]
5826
6279
  #
6280
+ # @!attribute [rw] explainer_config
6281
+ # A member of `CreateEndpointConfig` that enables explainers.
6282
+ # @return [Types::ExplainerConfig]
6283
+ #
5827
6284
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateEndpointConfigInput AWS API Documentation
5828
6285
  #
5829
6286
  class CreateEndpointConfigInput < Struct.new(
@@ -5832,7 +6289,8 @@ module Aws::SageMaker
5832
6289
  :data_capture_config,
5833
6290
  :tags,
5834
6291
  :kms_key_id,
5835
- :async_inference_config)
6292
+ :async_inference_config,
6293
+ :explainer_config)
5836
6294
  SENSITIVE = []
5837
6295
  include Aws::Structure
5838
6296
  end
@@ -6480,6 +6938,7 @@ module Aws::SageMaker
6480
6938
  # instance_group_name: "InstanceGroupName", # required
6481
6939
  # },
6482
6940
  # ],
6941
+ # keep_alive_period_in_seconds: 1,
6483
6942
  # },
6484
6943
  # stopping_condition: { # required
6485
6944
  # max_runtime_in_seconds: 1,
@@ -6603,6 +7062,7 @@ module Aws::SageMaker
6603
7062
  # instance_group_name: "InstanceGroupName", # required
6604
7063
  # },
6605
7064
  # ],
7065
+ # keep_alive_period_in_seconds: 1,
6606
7066
  # },
6607
7067
  # stopping_condition: { # required
6608
7068
  # max_runtime_in_seconds: 1,
@@ -9370,6 +9830,7 @@ module Aws::SageMaker
9370
9830
  # instance_group_name: "InstanceGroupName", # required
9371
9831
  # },
9372
9832
  # ],
9833
+ # keep_alive_period_in_seconds: 1,
9373
9834
  # },
9374
9835
  # vpc_config: {
9375
9836
  # security_group_ids: ["SecurityGroupId"], # required
@@ -13848,6 +14309,10 @@ module Aws::SageMaker
13848
14309
  # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html
13849
14310
  # @return [Types::AsyncInferenceConfig]
13850
14311
  #
14312
+ # @!attribute [rw] explainer_config
14313
+ # The configuration parameters for an explainer.
14314
+ # @return [Types::ExplainerConfig]
14315
+ #
13851
14316
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeEndpointConfigOutput AWS API Documentation
13852
14317
  #
13853
14318
  class DescribeEndpointConfigOutput < Struct.new(
@@ -13857,7 +14322,8 @@ module Aws::SageMaker
13857
14322
  :data_capture_config,
13858
14323
  :kms_key_id,
13859
14324
  :creation_time,
13860
- :async_inference_config)
14325
+ :async_inference_config,
14326
+ :explainer_config)
13861
14327
  SENSITIVE = []
13862
14328
  include Aws::Structure
13863
14329
  end
@@ -13971,6 +14437,10 @@ module Aws::SageMaker
13971
14437
  # endpoint configuration.
13972
14438
  # @return [Types::PendingDeploymentSummary]
13973
14439
  #
14440
+ # @!attribute [rw] explainer_config
14441
+ # The configuration parameters for an explainer.
14442
+ # @return [Types::ExplainerConfig]
14443
+ #
13974
14444
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeEndpointOutput AWS API Documentation
13975
14445
  #
13976
14446
  class DescribeEndpointOutput < Struct.new(
@@ -13985,7 +14455,8 @@ module Aws::SageMaker
13985
14455
  :last_modified_time,
13986
14456
  :last_deployment_config,
13987
14457
  :async_inference_config,
13988
- :pending_deployment_summary)
14458
+ :pending_deployment_summary,
14459
+ :explainer_config)
13989
14460
  SENSITIVE = []
13990
14461
  include Aws::Structure
13991
14462
  end
@@ -16815,6 +17286,10 @@ module Aws::SageMaker
16815
17286
  # The environment variables to set in the Docker container.
16816
17287
  # @return [Hash<String,String>]
16817
17288
  #
17289
+ # @!attribute [rw] warm_pool_status
17290
+ # The status of the warm pool associated with the training job.
17291
+ # @return [Types::WarmPoolStatus]
17292
+ #
16818
17293
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeTrainingJobResponse AWS API Documentation
16819
17294
  #
16820
17295
  class DescribeTrainingJobResponse < Struct.new(
@@ -16857,7 +17332,8 @@ module Aws::SageMaker
16857
17332
  :profiler_rule_evaluation_statuses,
16858
17333
  :profiling_status,
16859
17334
  :retry_strategy,
16860
- :environment)
17335
+ :environment,
17336
+ :warm_pool_status)
16861
17337
  SENSITIVE = []
16862
17338
  include Aws::Structure
16863
17339
  end
@@ -19146,6 +19622,57 @@ module Aws::SageMaker
19146
19622
  include Aws::Structure
19147
19623
  end
19148
19624
 
19625
+ # A parameter to activate explainers.
19626
+ #
19627
+ # @note When making an API call, you may pass ExplainerConfig
19628
+ # data as a hash:
19629
+ #
19630
+ # {
19631
+ # clarify_explainer_config: {
19632
+ # enable_explanations: "ClarifyEnableExplanations",
19633
+ # inference_config: {
19634
+ # features_attribute: "ClarifyFeaturesAttribute",
19635
+ # content_template: "ClarifyContentTemplate",
19636
+ # max_record_count: 1,
19637
+ # max_payload_in_mb: 1,
19638
+ # probability_index: 1,
19639
+ # label_index: 1,
19640
+ # probability_attribute: "ClarifyProbabilityAttribute",
19641
+ # label_attribute: "ClarifyLabelAttribute",
19642
+ # label_headers: ["ClarifyHeader"],
19643
+ # feature_headers: ["ClarifyHeader"],
19644
+ # feature_types: ["numerical"], # accepts numerical, categorical, text
19645
+ # },
19646
+ # shap_config: { # required
19647
+ # shap_baseline_config: { # required
19648
+ # mime_type: "ClarifyMimeType",
19649
+ # shap_baseline: "ClarifyShapBaseline",
19650
+ # shap_baseline_uri: "Url",
19651
+ # },
19652
+ # number_of_samples: 1,
19653
+ # use_logit: false,
19654
+ # seed: 1,
19655
+ # text_config: {
19656
+ # language: "af", # required, accepts af, sq, ar, hy, eu, bn, bg, ca, zh, hr, cs, da, nl, en, et, fi, fr, de, el, gu, he, hi, hu, is, id, ga, it, kn, ky, lv, lt, lb, mk, ml, mr, ne, nb, fa, pl, pt, ro, ru, sa, sr, tn, si, sk, sl, es, sv, tl, ta, tt, te, tr, uk, ur, yo, lij, xx
19657
+ # granularity: "token", # required, accepts token, sentence, paragraph
19658
+ # },
19659
+ # },
19660
+ # },
19661
+ # }
19662
+ #
19663
+ # @!attribute [rw] clarify_explainer_config
19664
+ # A member of `ExplainerConfig` that contains configuration parameters
19665
+ # for the SageMaker Clarify explainer.
19666
+ # @return [Types::ClarifyExplainerConfig]
19667
+ #
19668
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ExplainerConfig AWS API Documentation
19669
+ #
19670
+ class ExplainerConfig < Struct.new(
19671
+ :clarify_explainer_config)
19672
+ SENSITIVE = []
19673
+ include Aws::Structure
19674
+ end
19675
+
19149
19676
  # The container for the metadata for Fail step.
19150
19677
  #
19151
19678
  # @!attribute [rw] error_message
@@ -21568,6 +22095,7 @@ module Aws::SageMaker
21568
22095
  # instance_group_name: "InstanceGroupName", # required
21569
22096
  # },
21570
22097
  # ],
22098
+ # keep_alive_period_in_seconds: 1,
21571
22099
  # },
21572
22100
  # stopping_condition: { # required
21573
22101
  # max_runtime_in_seconds: 1,
@@ -28601,6 +29129,7 @@ module Aws::SageMaker
28601
29129
  # status_equals: "InProgress", # accepts InProgress, Completed, Failed, Stopping, Stopped
28602
29130
  # sort_by: "Name", # accepts Name, CreationTime, Status
28603
29131
  # sort_order: "Ascending", # accepts Ascending, Descending
29132
+ # warm_pool_status_equals: "Available", # accepts Available, Terminated, Reused, InUse
28604
29133
  # }
28605
29134
  #
28606
29135
  # @!attribute [rw] next_token
@@ -28650,6 +29179,11 @@ module Aws::SageMaker
28650
29179
  # The sort order for results. The default is `Ascending`.
28651
29180
  # @return [String]
28652
29181
  #
29182
+ # @!attribute [rw] warm_pool_status_equals
29183
+ # A filter that retrieves only training jobs with a specific warm pool
29184
+ # status.
29185
+ # @return [String]
29186
+ #
28653
29187
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListTrainingJobsRequest AWS API Documentation
28654
29188
  #
28655
29189
  class ListTrainingJobsRequest < Struct.new(
@@ -28662,7 +29196,8 @@ module Aws::SageMaker
28662
29196
  :name_contains,
28663
29197
  :status_equals,
28664
29198
  :sort_by,
28665
- :sort_order)
29199
+ :sort_order,
29200
+ :warm_pool_status_equals)
28666
29201
  SENSITIVE = []
28667
29202
  include Aws::Structure
28668
29203
  end
@@ -36388,6 +36923,7 @@ module Aws::SageMaker
36388
36923
  # instance_group_name: "InstanceGroupName", # required
36389
36924
  # },
36390
36925
  # ],
36926
+ # keep_alive_period_in_seconds: 1,
36391
36927
  # }
36392
36928
  #
36393
36929
  # @!attribute [rw] instance_type
@@ -36474,6 +37010,11 @@ module Aws::SageMaker
36474
37010
  # The configuration of a heterogeneous cluster in JSON format.
36475
37011
  # @return [Array<Types::InstanceGroup>]
36476
37012
  #
37013
+ # @!attribute [rw] keep_alive_period_in_seconds
37014
+ # The duration of time in seconds to retain configured resources in a
37015
+ # warm pool for subsequent training jobs.
37016
+ # @return [Integer]
37017
+ #
36477
37018
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ResourceConfig AWS API Documentation
36478
37019
  #
36479
37020
  class ResourceConfig < Struct.new(
@@ -36481,7 +37022,31 @@ module Aws::SageMaker
36481
37022
  :instance_count,
36482
37023
  :volume_size_in_gb,
36483
37024
  :volume_kms_key_id,
36484
- :instance_groups)
37025
+ :instance_groups,
37026
+ :keep_alive_period_in_seconds)
37027
+ SENSITIVE = []
37028
+ include Aws::Structure
37029
+ end
37030
+
37031
+ # The `ResourceConfig` to update `KeepAlivePeriodInSeconds`. Other
37032
+ # fields in the `ResourceConfig` cannot be updated.
37033
+ #
37034
+ # @note When making an API call, you may pass ResourceConfigForUpdate
37035
+ # data as a hash:
37036
+ #
37037
+ # {
37038
+ # keep_alive_period_in_seconds: 1, # required
37039
+ # }
37040
+ #
37041
+ # @!attribute [rw] keep_alive_period_in_seconds
37042
+ # The `KeepAlivePeriodInSeconds` value specified in the
37043
+ # `ResourceConfig` to update.
37044
+ # @return [Integer]
37045
+ #
37046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ResourceConfigForUpdate AWS API Documentation
37047
+ #
37048
+ class ResourceConfigForUpdate < Struct.new(
37049
+ :keep_alive_period_in_seconds)
36485
37050
  SENSITIVE = []
36486
37051
  include Aws::Structure
36487
37052
  end
@@ -39032,6 +39597,7 @@ module Aws::SageMaker
39032
39597
  # instance_group_name: "InstanceGroupName", # required
39033
39598
  # },
39034
39599
  # ],
39600
+ # keep_alive_period_in_seconds: 1,
39035
39601
  # },
39036
39602
  # stopping_condition: { # required
39037
39603
  # max_runtime_in_seconds: 1,
@@ -39213,6 +39779,10 @@ module Aws::SageMaker
39213
39779
  # The status of the training job.
39214
39780
  # @return [String]
39215
39781
  #
39782
+ # @!attribute [rw] warm_pool_status
39783
+ # The status of the warm pool associated with the training job.
39784
+ # @return [Types::WarmPoolStatus]
39785
+ #
39216
39786
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/TrainingJobSummary AWS API Documentation
39217
39787
  #
39218
39788
  class TrainingJobSummary < Struct.new(
@@ -39221,7 +39791,8 @@ module Aws::SageMaker
39221
39791
  :creation_time,
39222
39792
  :training_end_time,
39223
39793
  :last_modified_time,
39224
- :training_job_status)
39794
+ :training_job_status,
39795
+ :warm_pool_status)
39225
39796
  SENSITIVE = []
39226
39797
  include Aws::Structure
39227
39798
  end
@@ -42271,6 +42842,9 @@ module Aws::SageMaker
42271
42842
  # },
42272
42843
  # },
42273
42844
  # ],
42845
+ # resource_config: {
42846
+ # keep_alive_period_in_seconds: 1, # required
42847
+ # },
42274
42848
  # }
42275
42849
  #
42276
42850
  # @!attribute [rw] training_job_name
@@ -42288,12 +42862,18 @@ module Aws::SageMaker
42288
42862
  # and framework metrics.
42289
42863
  # @return [Array<Types::ProfilerRuleConfiguration>]
42290
42864
  #
42865
+ # @!attribute [rw] resource_config
42866
+ # The training job `ResourceConfig` to update warm pool retention
42867
+ # length.
42868
+ # @return [Types::ResourceConfigForUpdate]
42869
+ #
42291
42870
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateTrainingJobRequest AWS API Documentation
42292
42871
  #
42293
42872
  class UpdateTrainingJobRequest < Struct.new(
42294
42873
  :training_job_name,
42295
42874
  :profiler_config,
42296
- :profiler_rule_configurations)
42875
+ :profiler_rule_configurations,
42876
+ :resource_config)
42297
42877
  SENSITIVE = []
42298
42878
  include Aws::Structure
42299
42879
  end
@@ -43054,6 +43634,50 @@ module Aws::SageMaker
43054
43634
  include Aws::Structure
43055
43635
  end
43056
43636
 
43637
+ # Status and billing information about the warm pool.
43638
+ #
43639
+ # @!attribute [rw] status
43640
+ # The status of the warm pool.
43641
+ #
43642
+ # * `InUse`\: The warm pool is in use for the training job.
43643
+ #
43644
+ # * `Available`\: The warm pool is available to reuse for a matching
43645
+ # training job.
43646
+ #
43647
+ # * `Reused`\: The warm pool moved to a matching training job for
43648
+ # reuse.
43649
+ #
43650
+ # * `Terminated`\: The warm pool is no longer available. Warm pools
43651
+ # are unavailable if they are terminated by a user, terminated for a
43652
+ # patch update, or terminated for exceeding the specified
43653
+ # `KeepAlivePeriodInSeconds`.
43654
+ # @return [String]
43655
+ #
43656
+ # @!attribute [rw] resource_retained_billable_time_in_seconds
43657
+ # The billable time in seconds used by the warm pool. Billable time
43658
+ # refers to the absolute wall-clock time.
43659
+ #
43660
+ # Multiply `ResourceRetainedBillableTimeInSeconds` by the number of
43661
+ # instances (`InstanceCount`) in your training cluster to get the
43662
+ # total compute time SageMaker bills you if you run warm pool
43663
+ # training. The formula is as follows:
43664
+ # `ResourceRetainedBillableTimeInSeconds * InstanceCount`.
43665
+ # @return [Integer]
43666
+ #
43667
+ # @!attribute [rw] reused_by_job
43668
+ # The name of the matching training job that reused the warm pool.
43669
+ # @return [String]
43670
+ #
43671
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/WarmPoolStatus AWS API Documentation
43672
+ #
43673
+ class WarmPoolStatus < Struct.new(
43674
+ :status,
43675
+ :resource_retained_billable_time_in_seconds,
43676
+ :reused_by_job)
43677
+ SENSITIVE = []
43678
+ include Aws::Structure
43679
+ end
43680
+
43057
43681
  # A single private workforce, which is automatically created when you
43058
43682
  # create your first private work team. You can create one private work
43059
43683
  # force in each Amazon Web Services Region. By default, any