Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.Types.ClarifyTextConfig

Description

Synopsis

Documentation

data ClarifyTextConfig Source #

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: newClarifyTextConfig smart constructor.

Constructors

ClarifyTextConfig'

Fields

language :: ClarifyTextLanguage
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'.
granularity :: ClarifyTextGranularity
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.

Instances

Instances details

FromJSON ClarifyTextConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyTextConfig Methods parseJSON :: Value -> Parser ClarifyTextConfig # parseJSONList :: Value -> Parser [ClarifyTextConfig] #
ToJSON ClarifyTextConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyTextConfig Methods toJSON :: ClarifyTextConfig -> Value # toEncoding :: ClarifyTextConfig -> Encoding # toJSONList :: [ClarifyTextConfig] -> Value # toEncodingList :: [ClarifyTextConfig] -> Encoding #
Generic ClarifyTextConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyTextConfig Associated Types type Rep ClarifyTextConfig :: Type -> Type # Methods from :: ClarifyTextConfig -> Rep ClarifyTextConfig x # to :: Rep ClarifyTextConfig x -> ClarifyTextConfig #
Read ClarifyTextConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyTextConfig Methods readsPrec :: Int -> ReadS ClarifyTextConfig # readList :: ReadS [ClarifyTextConfig] # readPrec :: ReadPrec ClarifyTextConfig # readListPrec :: ReadPrec [ClarifyTextConfig] #
Show ClarifyTextConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyTextConfig Methods showsPrec :: Int -> ClarifyTextConfig -> ShowS # show :: ClarifyTextConfig -> String # showList :: [ClarifyTextConfig] -> ShowS #
NFData ClarifyTextConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyTextConfig Methods rnf :: ClarifyTextConfig -> () #
Eq ClarifyTextConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyTextConfig Methods (==) :: ClarifyTextConfig -> ClarifyTextConfig -> Bool # (/=) :: ClarifyTextConfig -> ClarifyTextConfig -> Bool #
Hashable ClarifyTextConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyTextConfig Methods hashWithSalt :: Int -> ClarifyTextConfig -> Int # hash :: ClarifyTextConfig -> Int #
type Rep ClarifyTextConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ClarifyTextConfig type Rep ClarifyTextConfig = D1 ('MetaData "ClarifyTextConfig" "Amazonka.SageMaker.Types.ClarifyTextConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ClarifyTextConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ClarifyTextLanguage) :*: S1 ('MetaSel ('Just "granularity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ClarifyTextGranularity)))

newClarifyTextConfig Source #

Arguments

:: ClarifyTextLanguage	`$sel:language:ClarifyTextConfig'`
-> ClarifyTextGranularity	`$sel:granularity:ClarifyTextConfig'`
-> ClarifyTextConfig

Create a value of ClarifyTextConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:language:ClarifyTextConfig', clarifyTextConfig_language - 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'.

$sel:granularity:ClarifyTextConfig', clarifyTextConfig_granularity - 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.

clarifyTextConfig_language :: Lens' ClarifyTextConfig ClarifyTextLanguage Source #

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'.

clarifyTextConfig_granularity :: Lens' ClarifyTextConfig ClarifyTextGranularity Source #

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.