iaml.plots.shap_plot

[PLOT] Wrap Shap Plot

Classes

ShapPlot

[PLOT] Wrap Shap Plot

Module Contents

class iaml.plots.shap_plot.ShapPlot(plot_key: str, shaps_values: shap.Explanation | shap.Cohorts | dict[shap.Explanation], *args, ps: slice = None, scatter_feature: Any | shap.Cohorts | None = None, **kwargs)

Bases: iaml.plot.Plot

[PLOT] Wrap Shap Plot

Parameters:

  • plot_key (str) – The kind of shap plot to use.

  • shaps_values (shap.Explanation | shap.Cohorts | dict[shap.Explanation]) – Values used by the shap library to compute data.

  • *args (optional) – Additional parameters.

  • ps (slice, optional) – Used to slice shaps_values. Default is None.

  • scatter_feature (optional) – Used to select specific shaps_values. Default is None.

  • **kwargs (optional) – Additional parameters.

key: str

The kind of shap plot to perform

classmethod all(shaps_values: shap.Explanation | shap.Cohorts | dict[shap.Explanation], *args, **kwargs) → list[ShapPlot]

Get instance for all kind of Shap Plot

Parameters:

  • shaps_values (shap.Explanation | shap.Cohorts | dict[shap.Explanation]) – Values used by the shap library to compute data.

  • *args (optional) – Additional parameters.

  • **kwargs (optional) – Additional parameters.

Returns:

list of computed ShapPlot.