aws-sdk-sagemaker 1.95.0 → 1.96.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b6ad55e6ba358f6f2bdb7d1d32266b4876ad899da2c9f71337882a0d362de82
-  data.tar.gz: 9f0dea84ca377db88dd5e908e811c5dd1fd685b2d0774b7453897ec82750bd38
+  metadata.gz: 021cb5b0efa607e2dadeda49f2f105093f0ee41141fe6cce95457f7cba88613b
+  data.tar.gz: 80c0e145e366990cb77ce3063ce96a93ec8e4485cafd2acfefa7270dbb0e36ca
 SHA512:
-  metadata.gz: 835a24d7bb5f59b712b084d6225a4155eb325edc143736fb000fe5914dfd1d086b24e05d16ffa14f3d0f7010169ef68cb306a61d0b601f2555a61034a3420233
-  data.tar.gz: 318a4931f18913f82abcbbcb0e4c1d3a6c4a84e5816a5b91ad9bccfbaca33c90bbccb8c22043286c6c265545986bdc8d47821e69293fd35cd30026e846d4d9dd
+  metadata.gz: 501cbaeea0d7689f925547b08707dfd942b946d47e4825b4d1c2e8bce7699febcb48e2db49d3a69377a1572eeea80c07da2fda8d4250dd42656343c8d2528bd0
+  data.tar.gz: 96b087849239d5c3e25211aebc5f96ed620535e82e3ba87b082c38079e8e9b3373b9c11ecd4eabd98395fcfeff6781deefae92bb10c5952f93e3d9d60a37eb7f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.96.0 (2021-08-12)
+------------------
+
+* Feature - Amazon SageMaker Autopilot adds new metrics for all candidate models generated by Autopilot experiments.
+
 1.95.0 (2021-07-30)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.95.0
+1.96.0

data/lib/aws-sdk-sagemaker.rb

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

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

@@ -1055,7 +1055,7 @@ module Aws::SageMaker
 
     # Creates an Autopilot job.
     #
-    # Find the best performing model after you run an Autopilot job by
+    # Find the best-performing model after you run an Autopilot job by
     # calling .
     #
     # For information about how to use Autopilot, see [Automate Model
@@ -3218,7 +3218,15 @@ module Aws::SageMaker
     #   configuration file. To learn how, see [Create a Labeling Category
     #   Configuration File for 3D Point Cloud Labeling Jobs][1].
     #
-    #   For all other [built-in task types][2] and [custom tasks][3], your
+    #   For named entity recognition jobs, in addition to `"labels"`, you must
+    #   provide worker instructions in the label category configuration file
+    #   using the `"instructions"` parameter: `"instructions":
+    #   \{"shortInstruction":"<h1>Add header</h1><p>Add Instructions</p>",
+    #   "fullInstruction":"<p>Add additional instructions.</p>"\}`. For
+    #   details and an example, see [Create a Named Entity Recognition
+    #   Labeling Job (API) ][2].
+    #
+    #   For all other [built-in task types][3] and [custom tasks][4], your
     #   label category configuration file must be a JSON file in the following
     #   format. Identify the labels you want to use by replacing `label_1`,
     #   `label_2`,`...`,`label_n` with your label categories.
@@ -3245,15 +3253,16 @@ module Aws::SageMaker
     #   * If you create a 3D point cloud or video frame adjustment or
     #     verification labeling job, you must include
     #     `auditLabelAttributeName` in the label category configuration. Use
-    #     this parameter to enter the [ `LabelAttributeName` ][4] of the
+    #     this parameter to enter the [ `LabelAttributeName` ][5] of the
     #     labeling job you want to adjust or verify annotations of.
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud-label-category-config.html
-    #   [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html
-    #   [3]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates.html
-    #   [4]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateLabelingJob.html#sagemaker-CreateLabelingJob-request-LabelAttributeName
+    #   [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-named-entity-recg.html#sms-creating-ner-api
+    #   [3]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html
+    #   [4]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates.html
+    #   [5]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateLabelingJob.html#sagemaker-CreateLabelingJob-request-LabelAttributeName
     #
     # @option params [Types::LabelingJobStoppingConditions] :stopping_conditions
     #   A set of conditions for stopping the labeling job. If any of the
@@ -7719,6 +7728,10 @@ module Aws::SageMaker
     #   resp.best_candidate.last_modified_time #=> Time
     #   resp.best_candidate.failure_reason #=> String
     #   resp.best_candidate.candidate_properties.candidate_artifact_locations.explainability #=> String
+    #   resp.best_candidate.candidate_properties.candidate_metrics #=> Array
+    #   resp.best_candidate.candidate_properties.candidate_metrics[0].metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC"
+    #   resp.best_candidate.candidate_properties.candidate_metrics[0].value #=> Float
+    #   resp.best_candidate.candidate_properties.candidate_metrics[0].set #=> String, one of "Train", "Validation", "Test"
     #   resp.auto_ml_job_status #=> String, one of "Completed", "InProgress", "Failed", "Stopped", "Stopping"
     #   resp.auto_ml_job_secondary_status #=> String, one of "Starting", "AnalyzingData", "FeatureEngineering", "ModelTuning", "MaxCandidatesReached", "Failed", "Stopped", "MaxAutoMLJobRuntimeReached", "Stopping", "CandidateDefinitionsGenerated", "GeneratingExplainabilityReport", "Completed", "ExplainabilityError", "DeployingModel", "ModelDeploymentError"
     #   resp.generate_candidate_definitions_only #=> Boolean
@@ -11457,6 +11470,10 @@ module Aws::SageMaker
     #   resp.candidates[0].last_modified_time #=> Time
     #   resp.candidates[0].failure_reason #=> String
     #   resp.candidates[0].candidate_properties.candidate_artifact_locations.explainability #=> String
+    #   resp.candidates[0].candidate_properties.candidate_metrics #=> Array
+    #   resp.candidates[0].candidate_properties.candidate_metrics[0].metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC"
+    #   resp.candidates[0].candidate_properties.candidate_metrics[0].value #=> Float
+    #   resp.candidates[0].candidate_properties.candidate_metrics[0].set #=> String, one of "Train", "Validation", "Test"
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListCandidatesForAutoMLJob AWS API Documentation
@@ -16101,6 +16118,8 @@ module Aws::SageMaker
 
     # Stops a pipeline execution.
     #
+    # **Callback Step**
+    #
     # A pipeline execution won't stop while a callback step is running.
     # When you call `StopPipelineExecution` on a pipeline execution with a
     # running callback step, SageMaker Pipelines sends an additional Amazon
@@ -16115,6 +16134,17 @@ module Aws::SageMaker
     # Only when SageMaker Pipelines receives one of these calls will it stop
     # the pipeline execution.
     #
+    # **Lambda Step**
+    #
+    # A pipeline execution can't be stopped while a lambda step is running
+    # because the Lambda function invoked by the lambda step can't be
+    # stopped. If you attempt to stop the execution while the Lambda
+    # function is running, the pipeline waits for the Lambda function to
+    # finish or until the timeout is hit, whichever occurs first, and then
+    # stops. If the Lambda function finishes, the pipeline execution status
+    # is `Stopped`. If the timeout is hit the pipeline execution status is
+    # `Failed`.
+    #
     # @option params [required, String] :pipeline_execution_arn
     #   The Amazon Resource Name (ARN) of the pipeline execution.
     #
@@ -17702,7 +17732,7 @@ module Aws::SageMaker
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-sagemaker'
-      context[:gem_version] = '1.95.0'
+      context[:gem_version] = '1.96.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -879,10 +879,13 @@ module Aws::SageMaker
     MetadataProperties = Shapes::StructureShape.new(name: 'MetadataProperties')
     MetadataPropertyValue = Shapes::StringShape.new(name: 'MetadataPropertyValue')
     MetricData = Shapes::StructureShape.new(name: 'MetricData')
+    MetricDataList = Shapes::ListShape.new(name: 'MetricDataList')
+    MetricDatum = Shapes::StructureShape.new(name: 'MetricDatum')
     MetricDefinition = Shapes::StructureShape.new(name: 'MetricDefinition')
     MetricDefinitionList = Shapes::ListShape.new(name: 'MetricDefinitionList')
     MetricName = Shapes::StringShape.new(name: 'MetricName')
     MetricRegex = Shapes::StringShape.new(name: 'MetricRegex')
+    MetricSetSource = Shapes::StringShape.new(name: 'MetricSetSource')
     MetricValue = Shapes::FloatShape.new(name: 'MetricValue')
     MetricsSource = Shapes::StructureShape.new(name: 'MetricsSource')
     ModelApprovalStatus = Shapes::StringShape.new(name: 'ModelApprovalStatus')
@@ -1718,6 +1721,7 @@ module Aws::SageMaker
     CandidateArtifactLocations.struct_class = Types::CandidateArtifactLocations
 
     CandidateProperties.add_member(:candidate_artifact_locations, Shapes::ShapeRef.new(shape: CandidateArtifactLocations, location_name: "CandidateArtifactLocations"))
+    CandidateProperties.add_member(:candidate_metrics, Shapes::ShapeRef.new(shape: MetricDataList, location_name: "CandidateMetrics"))
     CandidateProperties.struct_class = Types::CandidateProperties
 
     CandidateSteps.member = Shapes::ShapeRef.new(shape: AutoMLCandidateStep)
@@ -4781,6 +4785,13 @@ module Aws::SageMaker
     MetricData.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Timestamp"))
     MetricData.struct_class = Types::MetricData
 
+    MetricDataList.member = Shapes::ShapeRef.new(shape: MetricDatum)
+
+    MetricDatum.add_member(:metric_name, Shapes::ShapeRef.new(shape: AutoMLMetricEnum, location_name: "MetricName"))
+    MetricDatum.add_member(:value, Shapes::ShapeRef.new(shape: Float, location_name: "Value"))
+    MetricDatum.add_member(:set, Shapes::ShapeRef.new(shape: MetricSetSource, location_name: "Set"))
+    MetricDatum.struct_class = Types::MetricDatum
+
     MetricDefinition.add_member(:name, Shapes::ShapeRef.new(shape: MetricName, required: true, location_name: "Name"))
     MetricDefinition.add_member(:regex, Shapes::ShapeRef.new(shape: MetricRegex, required: true, location_name: "Regex"))
     MetricDefinition.struct_class = Types::MetricDefinition

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

@@ -797,7 +797,7 @@ module Aws::SageMaker
     #   Maximization approach to estimate the true class of text based on
     #   annotations from individual workers.
     #
-    #   * `rn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass`
+    #   * `arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass`
     #
     #   * `arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass`
     #
@@ -1707,8 +1707,8 @@ module Aws::SageMaker
       include Aws::Structure
     end
 
-    # An Autopilot job returns recommendations, or candidates. Each
-    # candidate has futher details about the steps involved and the status.
+    # Information about a candidate produced by an AutoML training job,
+    # including its status, steps, and other properties.
     #
     # @!attribute [rw] candidate_name
     #   The name of the candidate.
@@ -1751,7 +1751,7 @@ module Aws::SageMaker
     #   @return [String]
     #
     # @!attribute [rw] candidate_properties
-    #   The AutoML candidate's properties.
+    #   The properties of an AutoML candidate job.
     #   @return [Types::CandidateProperties]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/AutoMLCandidate AWS API Documentation
@@ -1842,7 +1842,8 @@ module Aws::SageMaker
     # that make up an AutoML candidate. For more information, see .
     #
     # @!attribute [rw] image
-    #   The ECR path of the container. For more information, see .
+    #   The Amazon Elastic Container Registry (Amazon ECR) path of the
+    #   container. For more information, see .
     #   @return [String]
     #
     # @!attribute [rw] model_data_url
@@ -2006,7 +2007,7 @@ module Aws::SageMaker
     #   * `MSE`\: The mean squared error (MSE) is the average of the squared
     #     differences between the predicted and actual values. It is used
     #     for regression. MSE values are always positive: the better a model
-    #     is at predicting the actual values, the smaller the MSE value.
+    #     is at predicting the actual values, the smaller the MSE value is.
     #     When the data contains outliers, they tend to dominate the MSE,
     #     which might cause subpar prediction performance.
     #
@@ -2085,7 +2086,7 @@ module Aws::SageMaker
     # Provides a summary about an AutoML job.
     #
     # @!attribute [rw] auto_ml_job_name
-    #   The name of the AutoML you are requesting.
+    #   The name of the AutoML job you are requesting.
     #   @return [String]
     #
     # @!attribute [rw] auto_ml_job_arn
@@ -2388,10 +2389,15 @@ module Aws::SageMaker
     #   candidate.
     #   @return [Types::CandidateArtifactLocations]
     #
+    # @!attribute [rw] candidate_metrics
+    #   Information about the candidate metrics for an AutoML job.
+    #   @return [Array<Types::MetricDatum>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CandidateProperties AWS API Documentation
     #
     class CandidateProperties < Struct.new(
-      :candidate_artifact_locations)
+      :candidate_artifact_locations,
+      :candidate_metrics)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3973,8 +3979,7 @@ module Aws::SageMaker
     end
 
     # @!attribute [rw] auto_ml_job_arn
-    #   The unique ARN that is assigned to the AutoML job when it is
-    #   created.
+    #   The unique ARN assigned to the AutoML job when it is created.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateAutoMLJobResponse AWS API Documentation
@@ -5947,7 +5952,15 @@ module Aws::SageMaker
     #   configuration file. To learn how, see [Create a Labeling Category
     #   Configuration File for 3D Point Cloud Labeling Jobs][1].
     #
-    #   For all other [built-in task types][2] and [custom tasks][3], your
+    #   For named entity recognition jobs, in addition to `"labels"`, you
+    #   must provide worker instructions in the label category configuration
+    #   file using the `"instructions"` parameter: `"instructions":
+    #   \{"shortInstruction":"<h1>Add header</h1><p>Add Instructions</p>",
+    #   "fullInstruction":"<p>Add additional instructions.</p>"\}`. For
+    #   details and an example, see [Create a Named Entity Recognition
+    #   Labeling Job (API) ][2].
+    #
+    #   For all other [built-in task types][3] and [custom tasks][4], your
     #   label category configuration file must be a JSON file in the
     #   following format. Identify the labels you want to use by replacing
     #   `label_1`, `label_2`,`...`,`label_n` with your label categories.
@@ -5974,15 +5987,16 @@ module Aws::SageMaker
     #   * If you create a 3D point cloud or video frame adjustment or
     #     verification labeling job, you must include
     #     `auditLabelAttributeName` in the label category configuration. Use
-    #     this parameter to enter the [ `LabelAttributeName` ][4] of the
+    #     this parameter to enter the [ `LabelAttributeName` ][5] of the
     #     labeling job you want to adjust or verify annotations of.
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud-label-category-config.html
-    #   [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html
-    #   [3]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates.html
-    #   [4]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateLabelingJob.html#sagemaker-CreateLabelingJob-request-LabelAttributeName
+    #   [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-named-entity-recg.html#sms-creating-ner-api
+    #   [3]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html
+    #   [4]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates.html
+    #   [5]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateLabelingJob.html#sagemaker-CreateLabelingJob-request-LabelAttributeName
     #   @return [String]
     #
     # @!attribute [rw] stopping_conditions
@@ -11117,7 +11131,7 @@ module Aws::SageMaker
     #   @return [Types::AutoMLJobArtifacts]
     #
     # @!attribute [rw] resolved_attributes
-    #   This contains `ProblemType`, `AutoMLJobObjective` and
+    #   This contains `ProblemType`, `AutoMLJobObjective`, and
     #   `CompletionCriteria`. If you do not provide these values, they are
     #   auto-inferred. If you do provide them, the values used are the ones
     #   you provide.
@@ -24737,6 +24751,31 @@ module Aws::SageMaker
       include Aws::Structure
     end
 
+    # Information about the metric for a candidate produced by an AutoML
+    # job.
+    #
+    # @!attribute [rw] metric_name
+    #   The name of the metric.
+    #   @return [String]
+    #
+    # @!attribute [rw] value
+    #   The value of the metric.
+    #   @return [Float]
+    #
+    # @!attribute [rw] set
+    #   The dataset split from which the AutoML job produced the metric.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/MetricDatum AWS API Documentation
+    #
+    class MetricDatum < Struct.new(
+      :metric_name,
+      :value,
+      :set)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Specifies a metric that the training algorithm writes to `stderr` or
     # `stdout`. Amazon SageMakerhyperparameter tuning captures all defined
     # metrics. You specify one metric that a hyperparameter tuning job uses
@@ -34096,7 +34135,14 @@ module Aws::SageMaker
     end
 
     # Provided configuration information for the worker UI for a labeling
-    # job.
+    # job. Provide either `HumanTaskUiArn` or `UiTemplateS3Uri`.
+    #
+    # For named entity recognition, 3D point cloud and video frame labeling
+    # jobs, use `HumanTaskUiArn`.
+    #
+    # For all other Ground Truth built-in task types and custom task types,
+    # use `UiTemplateS3Uri` to specify the location of a worker task
+    # template in Amazon S3.
     #
     # @note When making an API call, you may pass UiConfig
     #   data as a hash:
@@ -34122,11 +34168,21 @@ module Aws::SageMaker
     #   The ARN of the worker task template used to render the worker UI and
     #   tools for labeling job tasks.
     #
-    #   Use this parameter when you are creating a labeling job for 3D point
-    #   cloud and video fram labeling jobs. Use your labeling job task type
-    #   to select one of the following ARNs and use it with this parameter
-    #   when you create a labeling job. Replace `aws-region` with the Amazon
-    #   Web Services region you are creating your labeling job in.
+    #   Use this parameter when you are creating a labeling job for named
+    #   entity recognition, 3D point cloud and video frame labeling jobs.
+    #   Use your labeling job task type to select one of the following ARNs
+    #   and use it with this parameter when you create a labeling job.
+    #   Replace `aws-region` with the Amazon Web Services Region you are
+    #   creating your labeling job in. For example, replace `aws-region`
+    #   with `us-west-1` if you create a labeling job in US West (N.
+    #   California).
+    #
+    #   **Named Entity Recognition**
+    #
+    #   Use the following `HumanTaskUiArn` for named entity recognition
+    #   labeling jobs:
+    #
+    #   `arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition`
     #
     #   **3D Point Cloud HumanTaskUiArns**
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-sagemaker
 version: !ruby/object:Gem::Version
-  version: 1.95.0
+  version: 1.96.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core