Class ClarifyShapBaselineConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ClarifyShapBaselineConfig.Builder,
ClarifyShapBaselineConfig>
The configuration for the SHAP baseline (also called the background or reference dataset) of the Kernal SHAP algorithm.
-
The number of records in the baseline data determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.
-
ShapBaseline
andShapBaselineUri
are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
mimeType()
The MIME type of the baseline data.static Class
<? extends ClarifyShapBaselineConfig.Builder> final String
The inline SHAP baseline data in string format.final String
The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
mimeType
The MIME type of the baseline data. Choose from
'text/csv'
or'application/jsonlines'
. Defaults to'text/csv'
.- Returns:
- The MIME type of the baseline data. Choose from
'text/csv'
or'application/jsonlines'
. Defaults to'text/csv'
.
-
shapBaseline
The inline SHAP baseline data in string format.
ShapBaseline
can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by theGranularity
of theTextConfig
parameter. The size limit forShapBasline
is 4 KB. Use theShapBaselineUri
parameter if you want to provide more than 4 KB of baseline data.- Returns:
- The inline SHAP baseline data in string format.
ShapBaseline
can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by theGranularity
of theTextConfig
parameter. The size limit forShapBasline
is 4 KB. Use theShapBaselineUri
parameter if you want to provide more than 4 KB of baseline data.
-
shapBaselineUri
The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the
ShapBaselineUri
should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.- Returns:
- The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format
of the SHAP baseline file should be the same format as the format of the training dataset. For example,
if the training dataset is in CSV format, and each record in the training dataset has four features, and
all features are numerical, then the baseline file should also have this same format. Each record should
contain only the features. If you are using a virtual private cloud (VPC), the
ShapBaselineUri
should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ClarifyShapBaselineConfig.Builder,
ClarifyShapBaselineConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-