aws-sdk-sagemaker 1.139.0 → 1.140.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7deb3524a9430ff017818162aedf6e3bd8043f7ba2b728f8c64efaac5a527c0c
-  data.tar.gz: fb76d74dc54301fb330152d44fd95643b9360ea1e0f0cfd42c08a8b16e4547e2
+  metadata.gz: 183a3d0710845a318335195f1df77b55daec4ac09cce10e3f8d78aa502900df8
+  data.tar.gz: c52b1b8802e3bb268c7461a679e8a40621c2a987889458371e59595708deadbc
 SHA512:
-  metadata.gz: 4ae359d7efd1f2ee6e89f8f7b0c915b6de05162569c528111ccf3266381ad26003c9577df84a892f695ed05172fa566c8afc22e5650a5caead70aa73185bd68e
-  data.tar.gz: 29f83537ae4e0c80aeee9aa286ec7de6af46bdf6c9472832ea96fd2223c2c1e737057dcd9aa3e95801be0e84b0f0d09aad1a9c1711ebd5ff6e2781f98bdeb689
+  metadata.gz: 272cc69827d58efd70a692bd40bfbae65b89fd7e21db5e817ad9fa26785b2001d616a9797c720a7ab88ae5e32b07bd9237edd5dfc8800227d6d4d8385f98ef73
+  data.tar.gz: 87c6ec30a6c56ae2f46ad9ae99f26aded31705b658d707917940ba61a5b90c9423ebf890cf7bf3084fc1e48e763145c911b7094de28cbf259fb8b994a1781063

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.140.0 (2022-09-15)
+------------------
+
+* Feature - Amazon SageMaker Automatic Model Tuning now supports specifying Hyperband strategy for tuning jobs, which uses a multi-fidelity based tuning strategy to stop underperforming hyperparameter configurations early.
+
 1.139.0 (2022-09-08)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.139.0
+1.140.0

data/lib/aws-sdk-sagemaker/client.rb

@@ -940,8 +940,7 @@ module Aws::SageMaker
       req.send_request(options)
     end
 
-    # Creates a running app for the specified UserProfile. Supported apps
-    # are `JupyterServer` and `KernelGateway`. This operation is
+    # Creates a running app for the specified UserProfile. This operation is
     # automatically invoked by Amazon SageMaker Studio upon access to the
     # associated Domain, and when new kernel configurations are selected by
     # the user. A user may have multiple Apps active simultaneously.
@@ -953,8 +952,7 @@ module Aws::SageMaker
     #   The user profile name.
     #
     # @option params [required, String] :app_type
-    #   The type of app. Supported apps are `JupyterServer` and
-    #   `KernelGateway`. `TensorBoard` is not supported.
+    #   The type of app.
     #
     # @option params [required, String] :app_name
     #   The name of the app.
@@ -3015,7 +3013,13 @@ module Aws::SageMaker
     #   resp = client.create_hyper_parameter_tuning_job({
     #     hyper_parameter_tuning_job_name: "HyperParameterTuningJobName", # required
     #     hyper_parameter_tuning_job_config: { # required
-    #       strategy: "Bayesian", # required, accepts Bayesian, Random
+    #       strategy: "Bayesian", # required, accepts Bayesian, Random, Hyperband
+    #       strategy_config: {
+    #         hyperband_strategy_config: {
+    #           min_resource: 1,
+    #           max_resource: 1,
+    #         },
+    #       },
     #       hyper_parameter_tuning_job_objective: {
     #         type: "Maximize", # required, accepts Maximize, Minimize
     #         metric_name: "MetricName", # required
@@ -9722,7 +9726,9 @@ module Aws::SageMaker
     #
     #   resp.hyper_parameter_tuning_job_name #=> String
     #   resp.hyper_parameter_tuning_job_arn #=> String
-    #   resp.hyper_parameter_tuning_job_config.strategy #=> String, one of "Bayesian", "Random"
+    #   resp.hyper_parameter_tuning_job_config.strategy #=> String, one of "Bayesian", "Random", "Hyperband"
+    #   resp.hyper_parameter_tuning_job_config.strategy_config.hyperband_strategy_config.min_resource #=> Integer
+    #   resp.hyper_parameter_tuning_job_config.strategy_config.hyperband_strategy_config.max_resource #=> Integer
     #   resp.hyper_parameter_tuning_job_config.hyper_parameter_tuning_job_objective.type #=> String, one of "Maximize", "Minimize"
     #   resp.hyper_parameter_tuning_job_config.hyper_parameter_tuning_job_objective.metric_name #=> String
     #   resp.hyper_parameter_tuning_job_config.resource_limits.max_number_of_training_jobs #=> Integer
@@ -14078,7 +14084,7 @@ module Aws::SageMaker
     #   resp.hyper_parameter_tuning_job_summaries[0].hyper_parameter_tuning_job_name #=> String
     #   resp.hyper_parameter_tuning_job_summaries[0].hyper_parameter_tuning_job_arn #=> String
     #   resp.hyper_parameter_tuning_job_summaries[0].hyper_parameter_tuning_job_status #=> String, one of "Completed", "InProgress", "Failed", "Stopped", "Stopping"
-    #   resp.hyper_parameter_tuning_job_summaries[0].strategy #=> String, one of "Bayesian", "Random"
+    #   resp.hyper_parameter_tuning_job_summaries[0].strategy #=> String, one of "Bayesian", "Random", "Hyperband"
     #   resp.hyper_parameter_tuning_job_summaries[0].creation_time #=> Time
     #   resp.hyper_parameter_tuning_job_summaries[0].hyper_parameter_tuning_end_time #=> Time
     #   resp.hyper_parameter_tuning_job_summaries[0].last_modified_time #=> Time
@@ -17947,7 +17953,9 @@ module Aws::SageMaker
     #   resp.results[0].feature_metadata.parameters[0].value #=> String
     #   resp.results[0].hyper_parameter_tuning_job.hyper_parameter_tuning_job_name #=> String
     #   resp.results[0].hyper_parameter_tuning_job.hyper_parameter_tuning_job_arn #=> String
-    #   resp.results[0].hyper_parameter_tuning_job.hyper_parameter_tuning_job_config.strategy #=> String, one of "Bayesian", "Random"
+    #   resp.results[0].hyper_parameter_tuning_job.hyper_parameter_tuning_job_config.strategy #=> String, one of "Bayesian", "Random", "Hyperband"
+    #   resp.results[0].hyper_parameter_tuning_job.hyper_parameter_tuning_job_config.strategy_config.hyperband_strategy_config.min_resource #=> Integer
+    #   resp.results[0].hyper_parameter_tuning_job.hyper_parameter_tuning_job_config.strategy_config.hyperband_strategy_config.max_resource #=> Integer
     #   resp.results[0].hyper_parameter_tuning_job.hyper_parameter_tuning_job_config.hyper_parameter_tuning_job_objective.type #=> String, one of "Maximize", "Minimize"
     #   resp.results[0].hyper_parameter_tuning_job.hyper_parameter_tuning_job_config.hyper_parameter_tuning_job_objective.metric_name #=> String
     #   resp.results[0].hyper_parameter_tuning_job.hyper_parameter_tuning_job_config.resource_limits.max_number_of_training_jobs #=> Integer
@@ -20596,7 +20604,7 @@ module Aws::SageMaker
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-sagemaker'
-      context[:gem_version] = '1.139.0'
+      context[:gem_version] = '1.140.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-sagemaker/client_api.rb

@@ -754,6 +754,7 @@ module Aws::SageMaker
     HyperParameterTuningJobSearchEntity = Shapes::StructureShape.new(name: 'HyperParameterTuningJobSearchEntity')
     HyperParameterTuningJobSortByOptions = Shapes::StringShape.new(name: 'HyperParameterTuningJobSortByOptions')
     HyperParameterTuningJobStatus = Shapes::StringShape.new(name: 'HyperParameterTuningJobStatus')
+    HyperParameterTuningJobStrategyConfig = Shapes::StructureShape.new(name: 'HyperParameterTuningJobStrategyConfig')
     HyperParameterTuningJobStrategyType = Shapes::StringShape.new(name: 'HyperParameterTuningJobStrategyType')
     HyperParameterTuningJobSummaries = Shapes::ListShape.new(name: 'HyperParameterTuningJobSummaries')
     HyperParameterTuningJobSummary = Shapes::StructureShape.new(name: 'HyperParameterTuningJobSummary')
@@ -762,6 +763,9 @@ module Aws::SageMaker
     HyperParameterTuningResourceConfig = Shapes::StructureShape.new(name: 'HyperParameterTuningResourceConfig')
     HyperParameterValue = Shapes::StringShape.new(name: 'HyperParameterValue')
     HyperParameters = Shapes::MapShape.new(name: 'HyperParameters')
+    HyperbandStrategyConfig = Shapes::StructureShape.new(name: 'HyperbandStrategyConfig')
+    HyperbandStrategyMaxResource = Shapes::IntegerShape.new(name: 'HyperbandStrategyMaxResource')
+    HyperbandStrategyMinResource = Shapes::IntegerShape.new(name: 'HyperbandStrategyMinResource')
     IdempotencyToken = Shapes::StringShape.new(name: 'IdempotencyToken')
     Image = Shapes::StructureShape.new(name: 'Image')
     ImageArn = Shapes::StringShape.new(name: 'ImageArn')
@@ -4521,6 +4525,7 @@ module Aws::SageMaker
     HyperParameterTuningInstanceConfigs.member = Shapes::ShapeRef.new(shape: HyperParameterTuningInstanceConfig)
 
     HyperParameterTuningJobConfig.add_member(:strategy, Shapes::ShapeRef.new(shape: HyperParameterTuningJobStrategyType, required: true, location_name: "Strategy"))
+    HyperParameterTuningJobConfig.add_member(:strategy_config, Shapes::ShapeRef.new(shape: HyperParameterTuningJobStrategyConfig, location_name: "StrategyConfig"))
     HyperParameterTuningJobConfig.add_member(:hyper_parameter_tuning_job_objective, Shapes::ShapeRef.new(shape: HyperParameterTuningJobObjective, location_name: "HyperParameterTuningJobObjective"))
     HyperParameterTuningJobConfig.add_member(:resource_limits, Shapes::ShapeRef.new(shape: ResourceLimits, required: true, location_name: "ResourceLimits"))
     HyperParameterTuningJobConfig.add_member(:parameter_ranges, Shapes::ShapeRef.new(shape: ParameterRanges, location_name: "ParameterRanges"))
@@ -4552,6 +4557,9 @@ module Aws::SageMaker
     HyperParameterTuningJobSearchEntity.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
     HyperParameterTuningJobSearchEntity.struct_class = Types::HyperParameterTuningJobSearchEntity
 
+    HyperParameterTuningJobStrategyConfig.add_member(:hyperband_strategy_config, Shapes::ShapeRef.new(shape: HyperbandStrategyConfig, location_name: "HyperbandStrategyConfig"))
+    HyperParameterTuningJobStrategyConfig.struct_class = Types::HyperParameterTuningJobStrategyConfig
+
     HyperParameterTuningJobSummaries.member = Shapes::ShapeRef.new(shape: HyperParameterTuningJobSummary)
 
     HyperParameterTuningJobSummary.add_member(:hyper_parameter_tuning_job_name, Shapes::ShapeRef.new(shape: HyperParameterTuningJobName, required: true, location_name: "HyperParameterTuningJobName"))
@@ -4581,6 +4589,10 @@ module Aws::SageMaker
     HyperParameters.key = Shapes::ShapeRef.new(shape: HyperParameterKey)
     HyperParameters.value = Shapes::ShapeRef.new(shape: HyperParameterValue)
 
+    HyperbandStrategyConfig.add_member(:min_resource, Shapes::ShapeRef.new(shape: HyperbandStrategyMinResource, location_name: "MinResource"))
+    HyperbandStrategyConfig.add_member(:max_resource, Shapes::ShapeRef.new(shape: HyperbandStrategyMaxResource, location_name: "MaxResource"))
+    HyperbandStrategyConfig.struct_class = Types::HyperbandStrategyConfig
+
     Image.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "CreationTime"))
     Image.add_member(:description, Shapes::ShapeRef.new(shape: ImageDescription, location_name: "Description"))
     Image.add_member(:display_name, Shapes::ShapeRef.new(shape: ImageDisplayName, location_name: "DisplayName"))

data/lib/aws-sdk-sagemaker/types.rb

@@ -4440,8 +4440,7 @@ module Aws::SageMaker
     #   @return [String]
     #
     # @!attribute [rw] app_type
-    #   The type of app. Supported apps are `JupyterServer` and
-    #   `KernelGateway`. `TensorBoard` is not supported.
+    #   The type of app.
     #   @return [String]
     #
     # @!attribute [rw] app_name
@@ -6293,7 +6292,13 @@ module Aws::SageMaker
     #       {
     #         hyper_parameter_tuning_job_name: "HyperParameterTuningJobName", # required
     #         hyper_parameter_tuning_job_config: { # required
-    #           strategy: "Bayesian", # required, accepts Bayesian, Random
+    #           strategy: "Bayesian", # required, accepts Bayesian, Random, Hyperband
+    #           strategy_config: {
+    #             hyperband_strategy_config: {
+    #               min_resource: 1,
+    #               max_resource: 1,
+    #             },
+    #           },
     #           hyper_parameter_tuning_job_objective: {
     #             type: "Maximize", # required, accepts Maximize, Minimize
     #             metric_name: "MetricName", # required
@@ -17732,7 +17737,7 @@ module Aws::SageMaker
     #
     # @!attribute [rw] execution_role_identity_config
     #   The configuration for attaching a SageMaker user profile name to the
-    #   execution role as a [ `sts:SourceIdentity` key][1].
+    #   execution role as a [sts:SourceIdentity key][1].
     #
     #
     #
@@ -17774,9 +17779,9 @@ module Aws::SageMaker
     #
     # @!attribute [rw] execution_role_identity_config
     #   The configuration for attaching a SageMaker user profile name to the
-    #   execution role as a [ `sts:SourceIdentity` key][1]. This
-    #   configuration can only be modified if there are no apps in the
-    #   `InService` or `Pending` state.
+    #   execution role as a [sts:SourceIdentity key][1]. This configuration
+    #   can only be modified if there are no apps in the `InService` or
+    #   `Pending` state.
     #
     #
     #
@@ -21179,7 +21184,8 @@ module Aws::SageMaker
     #   Defines the maximum number of data objects that can be labeled by
     #   human workers at the same time. Also referred to as batch size. Each
     #   object may have more than one worker at one time. The default value
-    #   is 1000 objects.
+    #   is 1000 objects. To increase the maximum value to 5000 objects,
+    #   contact Amazon Web Services Support.
     #   @return [Integer]
     #
     # @!attribute [rw] annotation_consolidation_config
@@ -21848,7 +21854,13 @@ module Aws::SageMaker
     #   data as a hash:
     #
     #       {
-    #         strategy: "Bayesian", # required, accepts Bayesian, Random
+    #         strategy: "Bayesian", # required, accepts Bayesian, Random, Hyperband
+    #         strategy_config: {
+    #           hyperband_strategy_config: {
+    #             min_resource: 1,
+    #             max_resource: 1,
+    #           },
+    #         },
     #         hyper_parameter_tuning_job_objective: {
     #           type: "Maximize", # required, accepts Maximize, Minimize
     #           metric_name: "MetricName", # required
@@ -21889,16 +21901,21 @@ module Aws::SageMaker
     #
     # @!attribute [rw] strategy
     #   Specifies how hyperparameter tuning chooses the combinations of
-    #   hyperparameter values to use for the training job it launches. To
-    #   use the Bayesian search strategy, set this to `Bayesian`. To
-    #   randomly search, set it to `Random`. For information about search
-    #   strategies, see [How Hyperparameter Tuning Works][1].
+    #   hyperparameter values to use for the training job it launches. For
+    #   information about search strategies, see [How Hyperparameter Tuning
+    #   Works][1].
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html
     #   @return [String]
     #
+    # @!attribute [rw] strategy_config
+    #   The configuration for the `Hyperband` optimization strategy. This
+    #   parameter should be provided only if `Hyperband` is selected as the
+    #   strategy for `HyperParameterTuningJobConfig`.
+    #   @return [Types::HyperParameterTuningJobStrategyConfig]
+    #
     # @!attribute [rw] hyper_parameter_tuning_job_objective
     #   The HyperParameterTuningJobObjective object that specifies the
     #   objective metric for this tuning job.
@@ -21916,8 +21933,11 @@ module Aws::SageMaker
     #
     # @!attribute [rw] training_job_early_stopping_type
     #   Specifies whether to use early stopping for training jobs launched
-    #   by the hyperparameter tuning job. This can be one of the following
-    #   values (the default value is `OFF`):
+    #   by the hyperparameter tuning job. Because the `Hyperband` strategy
+    #   has its own advanced internal early stopping mechanism,
+    #   `TrainingJobEarlyStoppingType` must be `OFF` to use `Hyperband`.
+    #   This parameter can take on one of the following values (the default
+    #   value is `OFF`):
     #
     #   OFF
     #
@@ -21944,6 +21964,7 @@ module Aws::SageMaker
     #
     class HyperParameterTuningJobConfig < Struct.new(
       :strategy,
+      :strategy_config,
       :hyper_parameter_tuning_job_objective,
       :resource_limits,
       :parameter_ranges,
@@ -22101,6 +22122,42 @@ module Aws::SageMaker
       include Aws::Structure
     end
 
+    # The configuration for a training job launched by a hyperparameter
+    # tuning job. Choose `Bayesian` for Bayesian optimization, and `Random`
+    # for random search optimization. For more advanced use cases, use
+    # `Hyperband`, which evaluates objective metrics for training jobs after
+    # every epoch. For more information about strategies, see [How
+    # Hyperparameter Tuning Works][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html
+    #
+    # @note When making an API call, you may pass HyperParameterTuningJobStrategyConfig
+    #   data as a hash:
+    #
+    #       {
+    #         hyperband_strategy_config: {
+    #           min_resource: 1,
+    #           max_resource: 1,
+    #         },
+    #       }
+    #
+    # @!attribute [rw] hyperband_strategy_config
+    #   The configuration for the object that specifies the `Hyperband`
+    #   strategy. This parameter is only supported for the `Hyperband`
+    #   selection for `Strategy` within the `HyperParameterTuningJobConfig`
+    #   API.
+    #   @return [Types::HyperbandStrategyConfig]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/HyperParameterTuningJobStrategyConfig AWS API Documentation
+    #
+    class HyperParameterTuningJobStrategyConfig < Struct.new(
+      :hyperband_strategy_config)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Provides summary information about a hyperparameter tuning job.
     #
     # @!attribute [rw] hyper_parameter_tuning_job_name
@@ -22117,8 +22174,7 @@ module Aws::SageMaker
     #
     # @!attribute [rw] strategy
     #   Specifies the search strategy hyperparameter tuning uses to choose
-    #   which hyperparameters to use for each iteration. Currently, the only
-    #   valid value is Bayesian.
+    #   which hyperparameters to evaluate at each iteration.
     #   @return [String]
     #
     # @!attribute [rw] creation_time
@@ -22386,6 +22442,74 @@ module Aws::SageMaker
       include Aws::Structure
     end
 
+    # The configuration for `Hyperband`, a multi-fidelity based
+    # hyperparameter tuning strategy. `Hyperband` uses the final and
+    # intermediate results of a training job to dynamically allocate
+    # resources to utilized hyperparameter configurations while
+    # automatically stopping under-performing configurations. This parameter
+    # should be provided only if `Hyperband` is selected as the
+    # `StrategyConfig` under the `HyperParameterTuningJobConfig` API.
+    #
+    # @note When making an API call, you may pass HyperbandStrategyConfig
+    #   data as a hash:
+    #
+    #       {
+    #         min_resource: 1,
+    #         max_resource: 1,
+    #       }
+    #
+    # @!attribute [rw] min_resource
+    #   The minimum number of resources (such as epochs) that can be used by
+    #   a training job launched by a hyperparameter tuning job. If the value
+    #   for `MinResource` has not been reached, the training job will not be
+    #   stopped by `Hyperband`.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] max_resource
+    #   The maximum number of resources (such as epochs) that can be used by
+    #   a training job launched by a hyperparameter tuning job. Once a job
+    #   reaches the `MaxResource` value, it is stopped. If a value for
+    #   `MaxResource` is not provided, and `Hyperband` is selected as the
+    #   hyperparameter tuning strategy, `HyperbandTrainingJ` attempts to
+    #   infer `MaxResource` from the following keys (if present) in
+    #   [StaticsHyperParameters][1]\:
+    #
+    #   * `epochs`
+    #
+    #   * `numepochs`
+    #
+    #   * `n-epochs`
+    #
+    #   * `n_epochs`
+    #
+    #   * `num_epochs`
+    #
+    #   If `HyperbandStrategyConfig` is unable to infer a value for
+    #   `MaxResource`, it generates a validation error. The maximum value is
+    #   20,000 epochs. All metrics that correspond to an objective metric
+    #   are used to derive [early stopping decisions][2]. For
+    #   [distributive][3] training jobs, ensure that duplicate metrics are
+    #   not printed in the logs across the individual nodes in a training
+    #   job. If multiple nodes are publishing duplicate or incorrect
+    #   metrics, training jobs may make an incorrect stopping decision and
+    #   stop the job prematurely.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-StaticHyperParameters
+    #   [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html
+    #   [3]: https://docs.aws.amazon.com/sagemaker/latest/dg/distributed-training.html
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/HyperbandStrategyConfig AWS API Documentation
+    #
+    class HyperbandStrategyConfig < Struct.new(
+      :min_resource,
+      :max_resource)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # A SageMaker image. A SageMaker image represents a set of container
     # images that are derived from a common base container image. Each of
     # these container images is represented by a SageMaker `ImageVersion`.

data/lib/aws-sdk-sagemaker.rb

@@ -49,6 +49,6 @@ require_relative 'aws-sdk-sagemaker/customizations'
 # @!group service
 module Aws::SageMaker
 
-  GEM_VERSION = '1.139.0'
+  GEM_VERSION = '1.140.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-sagemaker
 version: !ruby/object:Gem::Version
-  version: 1.139.0
+  version: 1.140.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core