patch_display#

skrub.patch_display(pandas=True, polars=True, verbose=1, max_plot_columns=30)[source]#

Replace the default DataFrame HTML displays with skrub.TableReport.

This function replaces the HTML displays (what is shown when an object is the output of a jupyter notebook cell) of pandas and polars DataFrames with a TableReport.

It can be undone with skrub.unpatch_display().

Parameters:
pandasbool, optional (default=True)

If False, do not override the displays for pandas dataframes.

polarsbool, optional (default=True)

If False, do not override the displays for polars dataframes.

verboseint, default = 1

Whether to print progress information while table report is being generated.

  • verbose = 1 prints how many columns have been processed so far.

  • verbose = 0 silences the output.

max_plot_columnsint, default=30

Maximum number of columns for which plots should be generated. If the number of columns in the dataframe is greater than this value, the plots will not be generated. If None, all columns will be plotted.

See also

unpatch_display

Undo the change made by this function.

TableReport

Directly create a report from a dataframe.