Skip to content

Configuration

Every plotting function accepts an optional typed config object to override its defaults (colors, ordering, layout, ...). All config classes are Pydantic models and validate on construction.

Usual plots

BarConfig

Bases: BasePlotConfig

Configuration for the global feature-importance bar plot.

BeeswarmConfig

Bases: BasePlotConfig

Configuration for the beeswarm (summary) plot.

WaterfallConfig

Bases: BasePlotConfig

Configuration for the single-prediction waterfall plot.

ScatterConfig

Bases: BasePlotConfig

Configuration for the dependence / scatter plot.

HeatmapConfig

Bases: BasePlotConfig

Configuration for the instances-by-features heatmap.

DecisionConfig

Bases: BasePlotConfig

Configuration for the decision plot.

ForceConfig

Bases: BasePlotConfig

Configuration for the single-prediction force plot.

Advanced plots

BeeswarmRangesConfig

Bases: BeeswarmConfig

Configuration for the combined beeswarm + feature-value-ranges figure.

Extends :class:BeeswarmConfig with the options controlling the right-hand panel that shows the real distribution (violin + box) of each feature's values.

ErrorAnalysisConfig

Bases: BasePlotConfig

Configuration for the error-analysis plot (SHAP drivers of errors).

ExplanationArchetypesConfig

Bases: BasePlotConfig

Configuration for the SHAP-profile archetypes plot.

FeatureClusteringConfig

Bases: BasePlotConfig

Configuration for the SHAP-similarity feature-clustering heatmap.

ImportanceByCohortConfig

Bases: BasePlotConfig

Configuration for the cohort-wise importance plot.

ImportanceCIConfig

Bases: BasePlotConfig

Configuration for the bootstrap importance plot with confidence intervals.

InteractionHeatmapConfig

Bases: BasePlotConfig

Configuration for the pairwise SHAP-interaction heatmap.

MonotonicityConfig

Bases: BasePlotConfig

Configuration for the monotonicity-check plot.

ResponseCurveConfig

Bases: BasePlotConfig

Configuration for the response-curve plot (smoothed effect + thresholds).

ScatterRangesConfig

Bases: BasePlotConfig

Configuration for the dependence scatter framed by marginal distributions.

ShapSurfaceConfig

Bases: BasePlotConfig

Configuration for the 2D SHAP interaction surface.