Class: AWSCDK::Sagemaker::CfnEndpointConfig::ClarifyTextConfigProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Sagemaker::CfnEndpointConfig::ClarifyTextConfigProperty

Defined in:

sagemaker/cfn_endpoint_config.rb

Overview

A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text.

Required only for natural language processing (NLP) explainability.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifytextconfig.html

Instance Attribute Summary

• #granularity ⇒ String readonly

  The unit of granularity for the analysis of text features.

• #language ⇒ String readonly

  Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(granularity:, language:) ⇒ ClarifyTextConfigProperty constructor

  A new instance of ClarifyTextConfigProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(granularity:, language:) ⇒ ClarifyTextConfigProperty

Returns a new instance of ClarifyTextConfigProperty.

Parameters:

• granularity (String) —

  The unit of granularity for the analysis of text features.

• language (String) —

  Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

# File 'sagemaker/cfn_endpoint_config.rb', line 1328

def initialize(granularity:, language:)
  @granularity = granularity
  Jsii::Type.check_type(@granularity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "granularity")
  @language = language
  Jsii::Type.check_type(@language, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "language")
end

Instance Attribute Details

#granularity ⇒ String (readonly)

The unit of granularity for the analysis of text features.

For example, if the unit is 'token' , then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifytextconfig.html#cfn-sagemaker-endpointconfig-clarifytextconfig-granularity

# File 'sagemaker/cfn_endpoint_config.rb', line 1341

def granularity
  @granularity
end

#language ⇒ String (readonly)

Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

For a mix of multiple languages, use code 'xx' .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifytextconfig.html#cfn-sagemaker-endpointconfig-clarifytextconfig-language

# File 'sagemaker/cfn_endpoint_config.rb', line 1348

def language
  @language
end

Class Method Details

.jsii_properties ⇒ Object

# File 'sagemaker/cfn_endpoint_config.rb', line 1350

def self.jsii_properties
  {
    :granularity => "granularity",
    :language => "language",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'sagemaker/cfn_endpoint_config.rb', line 1357

def to_jsii
  result = {}
  result.merge!({
    "granularity" => @granularity,
    "language" => @language,
  })
  result.compact
end