set_config#

sklearn.set_config(assume_finite=None, working_memory=None, print_changed_only=None, display=None, pairwise_dist_chunk_size=None, enable_cython_pairwise_dist=None, array_api_dispatch=None, transform_output=None, enable_metadata_routing=None, skip_parameter_validation=None)[source]#

Set global scikit-learn configuration.

These settings control the behaviour of scikit-learn functions during a library usage session. Global configuration defaults (as described in the parameter list below) take effect when scikit-learn is imported.

This function can be used to modify the global scikit-learn configuration at runtime. Passing None as an argument (the default) leaves the corresponding setting unchanged. This allows users to selectively update the global configuration values without affecting the others.

Added in version 0.19.

Parameters:

assume_finitebool, default=None

If True, validation for finiteness will be skipped, saving time, but leading to potential crashes. If False, validation for finiteness will be performed, avoiding error. Global default: False.

Added in version 0.19.

working_memoryint, default=None

If set, scikit-learn will attempt to limit the size of temporary arrays to this number of MiB (per job when parallelised), often saving both computation time and memory on expensive operations that can be performed in chunks. Global default: 1024.

Added in version 0.20.

print_changed_onlybool, default=None

If True, only the parameters that were set to non-default values will be printed when printing an estimator. For example, print(SVC()) while True will only print ‘SVC()’ while the default behaviour would be to print ‘SVC(C=1.0, cache_size=200, …)’ with all the non-changed parameters. Global default: True.

Added in version 0.21.

Changed in version 0.23: Global default configuration changed from False to True.

display{‘text’, ‘diagram’}, default=None

If ‘diagram’, estimators will be displayed as a diagram in a Jupyter lab or notebook context. If ‘text’, estimators will be displayed as text. Global default: ‘diagram’.

Added in version 0.23.

pairwise_dist_chunk_sizeint, default=None

The number of row vectors per chunk for the accelerated pairwise- distances reduction backend. Global default: 256 (suitable for most of modern laptops’ caches and architectures).

Intended for easier benchmarking and testing of scikit-learn internals. End users are not expected to benefit from customizing this configuration setting.

Added in version 1.1.

enable_cython_pairwise_distbool, default=None

Use the accelerated pairwise-distances reduction backend when possible. Global default: True.

Intended for easier benchmarking and testing of scikit-learn internals. End users are not expected to benefit from customizing this configuration setting.

Added in version 1.1.

array_api_dispatchbool, default=None

Use Array API dispatching when inputs follow the Array API standard. Global default: False.

See the User Guide for more details.

Added in version 1.2.

transform_outputstr, default=None

Configure output of transform and fit_transform.

See Introducing the set_output API for an example on how to use the API.

"default": Default output format of a transformer
"pandas": DataFrame output
"polars": Polars output
None: Transform configuration is unchanged

Global default: “default”.

Added in version 1.2.

Added in version 1.4: "polars" option was added.

enable_metadata_routingbool, default=None

Enable metadata routing. By default this feature is disabled.

Refer to metadata routing user guide for more details.

True: Metadata routing is enabled
False: Metadata routing is disabled, use the old syntax.
None: Configuration is unchanged

Global default: False.

Added in version 1.3.

skip_parameter_validationbool, default=None

If True, disable the validation of the hyper-parameters’ types and values in the fit method of estimators and for arguments passed to public helper functions. It can save time in some situations but can lead to low level crashes and exceptions with confusing error messages. Global default: False.

Note that for data parameters, such as X and y, only type validation is skipped but validation with check_array will continue to run.

Added in version 1.3.