Class: Aws::SageMaker::Types::ClarifyInferenceConfig

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ClarifyInferenceConfig

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

The inference configuration parameter for the model container.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #content_template ⇒ String

  A template string used to format a JSON record into an acceptable model container input.

• #feature_headers ⇒ Array<String>

  The names of the features.

• #feature_types ⇒ Array<String>

  A list of data types of the features (optional).

• #features_attribute ⇒ String

  Provides the JMESPath expression to extract the features from a model container input in JSON Lines format.

• #label_attribute ⇒ String

  A JMESPath expression used to locate the list of label headers in the model container output.

• #label_headers ⇒ Array<String>

  For multiclass classification problems, the label headers are the names of the classes.

• #label_index ⇒ Integer

  A zero-based index used to extract a label header or list of label headers from model container output in CSV format.

• #max_payload_in_mb ⇒ Integer

  The maximum payload size (MB) allowed of a request from the explainer to the model container.

• #max_record_count ⇒ Integer

  The maximum number of records in a request that the model container can process when querying the model container for the predictions of a [synthetic dataset].

• #probability_attribute ⇒ String

  A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.

• #probability_index ⇒ Integer

  A zero-based index used to extract a probability value (score) or list from model container output in CSV format.

Instance Attribute Details

#content_template ⇒ String

A template string used to format a JSON record into an acceptable model container input. For example, a ‘ContentTemplate` string `’“myfeatures”:$features‘` will format a list of features `[1,2,3]` into the record string `’href="1,2,3">myfeatures”:‘`. Required only when the model container input is in JSON Lines format.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3916

class ClarifyInferenceConfig < Struct.new(
  :features_attribute,
  :content_template,
  :max_record_count,
  :max_payload_in_mb,
  :probability_index,
  :label_index,
  :probability_attribute,
  :label_attribute,
  :label_headers,
  :feature_headers,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end

#feature_headers ⇒ Array<String>

The names of the features. If provided, these are included in the endpoint response payload to help readability of the ‘InvokeEndpoint` output. See the [Response] section under **Invoke the endpoint** in the Developer Guide for more information.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response

Returns:

• (Array<String>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3916

class ClarifyInferenceConfig < Struct.new(
  :features_attribute,
  :content_template,
  :max_record_count,
  :max_payload_in_mb,
  :probability_index,
  :label_index,
  :probability_attribute,
  :label_attribute,
  :label_headers,
  :feature_headers,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end

#feature_types ⇒ Array<String>

A list of data types of the features (optional). Applicable only to NLP explainability. If provided, ‘FeatureTypes` must have at least one `’text’‘ string (for example, `[’text’]‘). If `FeatureTypes` is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the [response] section under **Invoke the endpoint** in the Developer Guide for more information.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response

Returns:

• (Array<String>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3916

class ClarifyInferenceConfig < Struct.new(
  :features_attribute,
  :content_template,
  :max_record_count,
  :max_payload_in_mb,
  :probability_index,
  :label_index,
  :probability_attribute,
  :label_attribute,
  :label_headers,
  :feature_headers,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end

#features_attribute ⇒ String

Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, if ‘FeaturesAttribute` is the JMESPath expression `’myfeatures’‘, it extracts a list of features `[1,2,3]` from request data `’href="1,2,3">myfeatures”:‘`.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3916

class ClarifyInferenceConfig < Struct.new(
  :features_attribute,
  :content_template,
  :max_record_count,
  :max_payload_in_mb,
  :probability_index,
  :label_index,
  :probability_attribute,
  :label_attribute,
  :label_headers,
  :feature_headers,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end

#label_attribute ⇒ String

A JMESPath expression used to locate the list of label headers in the model container output.

Example: If the model container output of a batch request is ‘’href=""cat","dog","fish"">labels”:,“probability”:‘`, then set `LabelAttribute` to `’labels’‘ to extract the list of label headers `[“cat”,“dog”,“fish”]`

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3916

class ClarifyInferenceConfig < Struct.new(
  :features_attribute,
  :content_template,
  :max_record_count,
  :max_payload_in_mb,
  :probability_index,
  :label_index,
  :probability_attribute,
  :label_attribute,
  :label_headers,
  :feature_headers,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end

#label_headers ⇒ Array<String>

For multiclass classification problems, the label headers are the names of the classes. Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the ‘InvokeEndpoint` API. See the [response] section under **Invoke the endpoint** in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response

Returns:

• (Array<String>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3916

class ClarifyInferenceConfig < Struct.new(
  :features_attribute,
  :content_template,
  :max_record_count,
  :max_payload_in_mb,
  :probability_index,
  :label_index,
  :probability_attribute,
  :label_attribute,
  :label_headers,
  :feature_headers,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end

#label_index ⇒ Integer

A zero-based index used to extract a label header or list of label headers from model container output in CSV format.

**Example for a multiclass model:** If the model container output consists of label headers followed by probabilities: ‘’“[‘cat’,‘dog’,‘fish’]”,“”‘`, set `LabelIndex` to `0` to select the label headers `[’cat’,‘dog’,‘fish’]‘.

Returns:

• (Integer)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3916

class ClarifyInferenceConfig < Struct.new(
  :features_attribute,
  :content_template,
  :max_record_count,
  :max_payload_in_mb,
  :probability_index,
  :label_index,
  :probability_attribute,
  :label_attribute,
  :label_headers,
  :feature_headers,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end

#max_payload_in_mb ⇒ Integer

The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to ‘6` MB.

Returns:

• (Integer)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3916

class ClarifyInferenceConfig < Struct.new(
  :features_attribute,
  :content_template,
  :max_record_count,
  :max_payload_in_mb,
  :probability_index,
  :label_index,
  :probability_attribute,
  :label_attribute,
  :label_headers,
  :feature_headers,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end

#max_record_count ⇒ Integer

The maximum number of records in a request that the model container can process when querying the model container for the predictions of a [synthetic dataset]. A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If ‘MaxRecordCount` is `1`, the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container’s capacity at runtime.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-synthetic

Returns:

• (Integer)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3916

class ClarifyInferenceConfig < Struct.new(
  :features_attribute,
  :content_template,
  :max_record_count,
  :max_payload_in_mb,
  :probability_index,
  :label_index,
  :probability_attribute,
  :label_attribute,
  :label_headers,
  :feature_headers,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end

#probability_attribute ⇒ String

A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.

Example: If the model container output of a single request is ‘’Aws::SageMaker::Types::ClarifyInferenceConfig.“predicted_label”:1,“probability”:0“predicted_label”:1,“probability”:0.6‘`, then set `ProbabilityAttribute` to `’probability’‘.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3916

class ClarifyInferenceConfig < Struct.new(
  :features_attribute,
  :content_template,
  :max_record_count,
  :max_payload_in_mb,
  :probability_index,
  :label_index,
  :probability_attribute,
  :label_attribute,
  :label_headers,
  :feature_headers,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end

#probability_index ⇒ Integer

A zero-based index used to extract a probability value (score) or list from model container output in CSV format. If this value is not provided, the entire model container output will be treated as a probability value (score) or list.

**Example for a single class model:** If the model container output consists of a string-formatted prediction label followed by its probability: ‘’1,0.6’‘, set `ProbabilityIndex` to `1` to select the probability value `0.6`.

**Example for a multiclass model:** If the model container output consists of a string-formatted prediction label followed by its probability: ‘’“[‘cat’,‘dog’,‘fish’]”,“”‘`, set `ProbabilityIndex` to `1` to select the probability values `[0.1,0.6,0.3]`.

Returns:

• (Integer)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3916

class ClarifyInferenceConfig < Struct.new(
  :features_attribute,
  :content_template,
  :max_record_count,
  :max_payload_in_mb,
  :probability_index,
  :label_index,
  :probability_attribute,
  :label_attribute,
  :label_headers,
  :feature_headers,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end