PDPConfig: Config class for Partial Dependence Plots (PDP).

In DyfanJones/sagemaker-r-common: R6sagemaker lower level api calls

Config class for Partial Dependence Plots (PDP).

Description

If PDP is requested, the Partial Dependence Plots will be included in the report, and the corresponding values will be included in the analysis output.

Super class

sagemaker.common::ExplainabilityConfig -> PDPConfig

Public fields

pdp_config

PDP Config

Methods

Public methods

• PDPConfig$new()

• PDPConfig$get_explainability_config()

• PDPConfig$clone()

Inherited methods

• sagemaker.common::ExplainabilityConfig$format()

---

Method new()

Initializes config for PDP.

Usage

PDPConfig$new(features = NULL, grid_resolution = 15, top_k_features = 10)

Arguments

features

(None or list): List of features names or indices for which partial dependence plots must be computed and plotted. When ShapConfig is provided, this parameter is optional as Clarify will try to compute the partial dependence plots for top feature based on SHAP attributions. When ShapConfig is not provided, 'features' must be provided.

grid_resolution

(int): In case of numerical features, this number represents that number of buckets that range of values must be divided into. This decides the granularity of the grid in which the PDP are plotted.

top_k_features

(int): Set the number of top SHAP attributes to be selected to compute partial dependence plots.

---

Method get_explainability_config()

Returns config.

Usage

PDPConfig$get_explainability_config()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

PDPConfig$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-common documentation built on June 14, 2022, 10:31 p.m.