pdstools.explanations.Plots

Classes

Plots

Plots.

Module Contents

class Plots(explanations: pdstools.explanations.Explanations.Explanations)

Bases: pdstools.utils.namespaces.LazyNamespace

Plots.

Parameters:

explanations (pdstools.explanations.Explanations.Explanations)

dependencies: ClassVar[list[str]] = ['numpy', 'plotly']

dependency_group = 'explanations'

explanations

aggregates

contributions_overall(top_n: int = ..., top_k: int = ..., *, return_df: Literal[False] = ..., sort_by: pdstools.explanations._constants.ContributionType = ..., display_by: pdstools.explanations._constants.ContributionType = ..., descending: bool = ..., missing: bool = ..., remaining: bool = ..., include_numeric_single_bin: bool = ...) → tuple[plotly.graph_objects.Figure, list[plotly.graph_objects.Figure]]

contributions_overall(top_n: int = ..., top_k: int = ..., *, return_df: Literal[True], sort_by: pdstools.explanations._constants.ContributionType = ..., display_by: pdstools.explanations._constants.ContributionType = ..., descending: bool = ..., missing: bool = ..., remaining: bool = ..., include_numeric_single_bin: bool = ...) → tuple[polars.DataFrame, polars.DataFrame]

Plot contributions for overall.

contributions_by_context(context: dict[str, str], top_n: int = ..., top_k: int = ..., *, return_df: Literal[False] = ..., sort_by: pdstools.explanations._constants.ContributionType = ..., display_by: pdstools.explanations._constants.ContributionType = ..., descending: bool = ..., missing: bool = ..., remaining: bool = ..., include_numeric_single_bin: bool = ...) → tuple[plotly.graph_objects.Figure, plotly.graph_objects.Figure, list[plotly.graph_objects.Figure]]

contributions_by_context(context: dict[str, str], top_n: int = ..., top_k: int = ..., *, return_df: Literal[True], sort_by: pdstools.explanations._constants.ContributionType = ..., display_by: pdstools.explanations._constants.ContributionType = ..., descending: bool = ..., missing: bool = ..., remaining: bool = ..., include_numeric_single_bin: bool = ...) → tuple[polars.DataFrame, polars.DataFrame]

Plot contributions by context.