patch_display#

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

plot_distributionsbool or “auto”, default=”auto”

Whether to plot distributions in TableReport. - True: always generate plots, regardless of column count. - False: never generate plots. - "auto" (default): generate plots only when the number of columns

does not exceed the configured plots_threshold (see set_config()).

compute_associationsbool or “auto”, default=”auto”

Whether to compute associations in TableReport. - True: always compute associations, regardless of column count. - False: never compute associations. - "auto" (default): compute associations only when the number of

columns does not exceed the configured associations_threshold (see set_config()).

See also

unpatch_display

Undo the change made by this function.

TableReport

Directly create a report from a dataframe.