patch_display#

skrub.patch_display(pandas=True, polars=True, verbose=1, plot_distributions=False, compute_associations=False)[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 unpatch_display().

Parameters:
pandaspython:bool, optional (default=True)

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

polarspython:bool, optional (default=True)

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

verbosepython:int, 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.

plot_distributionspython:bool or “auto”, default=False

Whether to plot distributions in TableReport.

  • True: always generate plots, regardless of column count.

  • False: never generate plots.

  • "auto": generate plots only when the number of columns does not exceed the configured table_report_plots_threshold (see set_config()).

compute_associationspython:bool or “auto”, default=False

Whether to compute associations in TableReport.

  • True: always compute associations, regardless of column count.

  • False: never compute associations.

  • "auto": compute associations only when the number of columns does not exceed the configured table_report_associations_threshold (see set_config()).

See also

unpatch_display

Undo the change made by this function.

TableReport

Directly create a report from a dataframe.