Skip to content

plot_shap_heatmap

method plot_shap_heatmap(models=None, rows="test", show=None, target=1, title=None, legend=None, figsize=None, filename=None, display=True)[source]

Plot SHAP's heatmap plot.

This plot is designed to show the population substructure of a dataset using supervised clustering and a heatmap. Supervised clustering involves clustering data points not by their original feature values but by their explanations. Read more about SHAP plots in the user guide.

Parameters models: int, str, Model or None, default=None
Model to plot. If None, all models are selected. Note that leaving the default option could raise an exception if there are multiple models. To avoid this, call the plot directly from a model, e.g., atom.lr.plot_shap_heatmap().

rows: hashable, segment, sequence or dataframe, default="test"
Selection of rows to plot. The plot_shap_heatmap method does not support plotting a single sample.

show: int or None, default=None
Number of features (ordered by importance) to show. If None, it shows all features.

target: int, str or tuple, default=1
Class in the target column to target. For multioutput tasks, the value should be a tuple of the form (column, class). Note that for binary and multilabel tasks, the selected class is always the positive one.

title: str, dict or None, default=None
Title for the plot.

legend: str, dict or None, default=None
Do nothing. Implemented for continuity of the API.

figsize: tuple or None, default=None
Figure's size in pixels, format as (x, y). If None, it adapts the size to the number of features shown.

filename: str, Path or None, default=None
Save the plot using this name. Use "auto" for automatic naming. The type of the file depends on the provided name (.html, .png, .pdf, etc...). If filename has no file type, the plot is saved as png. If None, the plot is not saved.

display: bool or None, default=True
Whether to render the plot. If None, it returns the figure.

Returns{#plot_shap_heatmap-plt.Figure or None} plt.Figure or None
Plot object. Only returned if display=None.


See Also

plot_shap_decision

Plot SHAP's decision plot.

plot_shap_force

Plot SHAP's force plot.

plot_shap_waterfall

Plot SHAP's waterfall plot.


Example

>>> from atom import ATOMClassifier
>>> from sklearn.datasets import load_breast_cancer

>>> X, y = load_breast_cancer(return_X_y=True, as_frame=True)

>>> atom = ATOMClassifier(X, y, random_state=1)
>>> atom.run("LR")
>>> atom.plot_shap_heatmap(show=10)
atom.plot_shap_heatmap