aws-cdk-lib.aws_sagemaker.CfnEndpointConfig.ClarifyInferenceConfigProperty

ClarifyInferenceConfigProperty Struct

The inference configuration parameter for the model container.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const clarifyInferenceConfigProperty: sagemaker.CfnEndpointConfig.ClarifyInferenceConfigProperty = {
  contentTemplate: 'contentTemplate',
  featureHeaders: ['featureHeaders'],
  featuresAttribute: 'featuresAttribute',
  featureTypes: ['featureTypes'],
  labelAttribute: 'labelAttribute',
  labelHeaders: ['labelHeaders'],
  labelIndex: 123,
  maxPayloadInMb: 123,
  maxRecordCount: 123,
  probabilityAttribute: 'probabilityAttribute',
  probabilityIndex: 123,
};

Properties

contentTemplate?optionalstringcontent_template?optionalstrcontentTemplate?optionalStringContentTemplate?optionalstringContentTemplate?optional*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 '{"myfeatures":[1,2,3]}' . Required only when the model container input is in JSON Lines format.

featureHeaders?optionalstring[]feature_headers?optionaltyping.List[str]featureHeaders?optionalList<String>FeatureHeaders?optionalstring[]FeatureHeaders?optional*[]*string#

The names of the features.

notes

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.

featuresAttribute?optionalstringfeatures_attribute?optionalstrfeaturesAttribute?optionalStringFeaturesAttribute?optionalstringFeaturesAttribute?optional*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 '{"myfeatures":[1,2,3]}' .

featureTypes?optionalstring[]feature_types?optionaltyping.List[str]featureTypes?optionalList<String>FeatureTypes?optionalstring[]FeatureTypes?optional*[]*string#

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

notes

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.

labelAttribute?optionalstringlabel_attribute?optionalstrlabelAttribute?optionalStringLabelAttribute?optionalstringLabelAttribute?optional*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 '{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}' , then set LabelAttribute to 'labels' to extract the list of label headers ["cat","dog","fish"]

labelHeaders?optionalstring[]label_headers?optionaltyping.List[str]labelHeaders?optionalList<String>LabelHeaders?optionalstring[]LabelHeaders?optional*[]*string#

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

notes

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.

labelIndex?optionalnumberlabel_index?optionalint | floatlabelIndex?optionalNumberLabelIndex?optionaldoubleLabelIndex?optional*float64#

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

notes

Example for a multiclass model: If the model container output consists of label headers followed by probabilities: '"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"' , set LabelIndex to 0 to select the label headers ['cat','dog','fish'] .

maxPayloadInMb?optionalnumbermax_payload_in_mb?optionalint | floatmaxPayloadInMb?optionalNumberMaxPayloadInMb?optionaldoubleMaxPayloadInMb?optional*float64#

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

Defaults to 6 MB.

maxRecordCount?optionalnumbermax_record_count?optionalint | floatmaxRecordCount?optionalNumberMaxRecordCount?optionaldoubleMaxRecordCount?optional*float64#

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](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-synthetic) . 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.

probabilityAttribute?optionalstringprobability_attribute?optionalstrprobabilityAttribute?optionalStringProbabilityAttribute?optionalstringProbabilityAttribute?optional*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 '{"predicted_label":1,"probability":0.6}' , then set ProbabilityAttribute to 'probability' .

probabilityIndex?optionalnumberprobability_index?optionalint | floatprobabilityIndex?optionalNumberProbabilityIndex?optionaldoubleProbabilityIndex?optional*float64#

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

notes

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\']","[0.1,0.6,0.3]"' , set ProbabilityIndex to 1 to select the probability values [0.1,0.6,0.3] .