configuration#

skore.configuration = Configuration(show_progress=True, plot_backend='matplotlib', ignore_checks=None)[source]#

Configuration for skore behavior.

You can read and set options via attribute access. In parallel processing (e.g. joblib.Parallel), each thread receives its own copy of the configuration; changing attributes inside a worker thread only affects that thread and does not modify the global configuration in the main thread.

Attributes:

show_progressbool: Whether to show progress bars for long-running operations. Default is True (or False when joblib < 1.4).
plot_backendstr: Backend used for rendering plots (e.g. "matplotlib"). Default is "matplotlib".
ignore_checkslist of str or tuple of str or None: Global diagnostic codes ignored by report.diagnose(...). Default is None.

Examples

Global configuration using the configuration instance from skore:

>>> # xdoctest: +SKIP
>>> from skore import configuration
>>> configuration.show_progress = False
>>> configuration.plot_backend = "matplotlib"
>>> configuration.ignore_checks = ["SKD001"]

Temporary overrides using the context manager (previous values are restored on exit):

>>> # xdoctest: +SKIP
>>> with configuration(show_progress=False):
...     report.fit(X, y)
>>> with configuration(plot_backend="plotly"):
...     report.plot()
>>> with configuration(ignore_checks=["SKD002"]):
...     report.diagnose()