config_context#

sklearn.config_context(*, 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]#

上下文管理器，用于临时更改 scikit-learn 的全局配置。

此上下文管理器可用于在 with 语句的作用域内应用 scikit-learn 配置更改。一旦上下文退出，全局配置将恢复。

默认全局配置（在导入 scikit-learn 时生效）在下面的参数列表中定义。

参数:

assume_finitebool, default=None

如果为 True，将跳过有限性验证，从而节省时间，但可能导致潜在的崩溃。如果为 False，将执行有限性验证，从而避免错误。如果为 None，则现有配置不会更改。全局默认值：False。

working_memoryint, default=None

如果设置了此值，scikit-learn 将尝试将临时数组的大小限制在此 MiB 数（并行化时每个作业），通常可以在可以分块执行的昂贵操作中节省计算时间和内存。如果为 None，则现有配置不会更改。全局默认值：1024。

print_changed_onlybool, default=None

如果为 True，则在打印估计器时，将只打印设置为非默认值的参数。例如，当为 True 时，print(SVC()) 将只打印 'SVC()'，但当为 False 时，它会打印 'SVC(C=1.0, cache_size=200, ...)' 以及所有未更改的参数。如果为 None，则现有配置不会更改。全局默认值：True。

版本 0.23 中的更改：全局默认配置从 False 更改为 True。

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

如果为 'diagram'，估计器将以图表形式显示在 Jupyter lab 或 notebook 上下文中。如果为 'text'，估计器将以文本形式显示。如果为 None，则现有配置不会更改。全局默认值：'diagram'。

0.23 版本新增。

pairwise_dist_chunk_sizeint, default=None

加速成对距离约简后端每个块的行向量数。全局默认值：256（适用于大多数现代笔记本电脑的缓存和架构）。

旨在更轻松地对 scikit-learn 内部进行基准测试和测试。不期望最终用户能从自定义此配置设置中受益。

版本 1.1 中新增。

enable_cython_pairwise_distbool, default=None

在可能的情况下使用加速成对距离约简后端。全局默认值：True。

旨在更轻松地对 scikit-learn 内部进行基准测试和测试。不期望最终用户能从自定义此配置设置中受益。

版本 1.1 中新增。

array_api_dispatchbool, default=None

当输入遵循 Array API 标准时使用 Array API 调度。全局默认值：False。

有关更多详细信息，请参阅用户指南。

1.2 版本新增。

transform_outputstr, default=None

配置 transform 和 fit_transform 的输出。

有关如何使用 API 的示例，请参阅引入 set_output API。

"default": 转换器的默认输出格式
"pandas": DataFrame 输出
"polars": Polars 输出
None: 转换配置保持不变

全局默认值：“default”。

1.2 版本新增。

1.4 版本新增: 添加了 "polars" 选项。

enable_metadata_routingbool, default=None

启用元数据路由。默认情况下此功能处于禁用状态。

有关更多详细信息，请参阅元数据路由用户指南。

True：元数据路由已启用
False：元数据路由已禁用，使用旧语法。
None：配置未更改

全局默认值：False。

在版本 1.3 中新增。

skip_parameter_validationbool, default=None

如果为 True，则禁用估计器 fit 方法中超参数的类型和值验证，以及传递给公共辅助函数的参数验证。在某些情况下可以节省时间，但可能导致低级崩溃和带有令人困惑的错误消息的异常。全局默认值：False。

请注意，对于数据参数（例如 X 和 y），仅跳过类型验证，但 check_array 的验证将继续运行。

在版本 1.3 中新增。

生成:

无。

另请参阅

set_config: 设置 scikit-learn 的全局配置。
get_config: 检索全局配置的当前值。

注意事项

当上下文管理器退出时，所有设置（不仅仅是当前修改的设置）都将恢复到其先前的值。

示例

>>> import sklearn
>>> from sklearn.utils.validation import assert_all_finite
>>> with sklearn.config_context(assume_finite=True):
...     assert_all_finite([float('nan')])
>>> with sklearn.config_context(assume_finite=True):
...     with sklearn.config_context(assume_finite=False):
...         assert_all_finite([float('nan')])
Traceback (most recent call last):
...
ValueError: Input contains NaN...

Gallery examples#

介绍 set_output API

config_context#

Gallery examples#

本页