plot_all

scikitplot.decile.plot_all(plot_input, *, highlight_ntile=None, highlight_how='plot_text', autopct='%.2f%%', figsize=(15, 10), line_kws=None, ref_line_kws=None, legend_kws=None, grid_kws=None, axes_kws=None, annotation_kws=None, footer_kws=None, save_fig=True, save_fig_filename='', **kwargs)

Plot response, cumulative response, cumulative lift, and cumulative gains as a 2x2 panel.

Parameters:

plot_inputpandas.DataFrame

Output of ModelPlotPy.plotting_scope.

highlight_ntileint, Sequence[int], or None, default=None

Ntile(s) to highlight across all subplots.

highlight_how{‘plot’, ‘text’, ‘plot_text’}, default=’plot_text’

Where to render highlight information.

• ‘text’ prints standardized lines to stdout

• ‘plot’ renders them in a footer area

• ‘plot_text’ does both

autopctNone or str or callable, default=’%.2f%%’

Percentage formatter.

figsizetuple[int, int], default=(15, 10)

Figure size.

line_kws, ref_line_kws, legend_kws, grid_kws, axes_kws, annotation_kws, footer_kwsMapping[str, Any] or None

Per-component styling kwargs.

**kwargsAny

Legacy alias for line_kws.

Returns:

matplotlib.axes.Axes

The top-left subplot axis (cumulative gains), matching legacy behavior.

Other Parameters:

show_figbool, default=True

Show the plot.

Added in version 0.4.0.

save_figbool, default=False

Save the plot. Used by save_plot_decorator.

Added in version 0.4.0.

save_fig_filenamestr, optional, default=’’

Specify the path and filetype to save the plot. If nothing specified, the plot will be saved as png inside result_images under to the current working directory. Defaults to plot image named to used func.__name__. Used by save_plot_decorator.

Added in version 0.4.0.

overwritebool, optional, default=True

If False and a file exists, auto-increments the filename to avoid overwriting.

Added in version 0.4.0.

add_timestampbool, optional, default=False

Whether to append a timestamp to the filename. Default is False.

Added in version 0.4.0.

verbosebool, optional

If True, enables verbose output with informative messages during execution. Useful for debugging or understanding internal operations such as backend selection, font loading, and file saving status. If False, runs silently unless errors occur.

Default is False.

Added in version 0.4.0: The verbose parameter was added to control logging and user feedback verbosity.

Raises:

_PlotInputError

If required columns are missing.

Parameters:

• plot_input (DataFrame)

• highlight_ntile (int | Sequence[int] | None)

• highlight_how (Literal['plot', 'text', 'plot_text'])

• autopct (str | Callable[[float], str] | None)

• figsize (tuple[int, int])

• line_kws (Mapping[str, Any] | None)

• ref_line_kws (Mapping[str, Any] | None)

• legend_kws (Mapping[str, Any] | None)

• grid_kws (Mapping[str, Any] | None)

• axes_kws (Mapping[str, Any] | None)

• annotation_kws (Mapping[str, Any] | None)

• footer_kws (Mapping[str, Any] | None)

• save_fig (bool)

• save_fig_filename (str)

• kwargs (Any)

Return type:

Axes

See also

plot_response, plot_cumresponse, plot_cumlift, plot_cumgains

Notes

Dev note: plot_all must not call other decorated plot_* functions. Nesting save_plot_decorator calls can clear/close figures unexpectedly.

Examples

>>> # ax = plot_all(plot_input)

Gallery examples

Introduction to modelplotpy

Introduction to modelplotpy