OrdinalEncoder#

class sklearn.preprocessing.OrdinalEncoder(*, categories='auto', dtype=<class 'numpy.float64'>, handle_unknown='error', unknown_value=None, encoded_missing_value=nan, min_frequency=None, max_categories=None)[source]#

将分类特征编码为整数数组。

此转换器的输入应为整数或字符串的类数组，表示分类（离散）特征所取的值。特征将转换为序数整数。这将为每个特征生成一个整数列（从 0 到 n_categories - 1）。

在用户指南中了解更多信息。有关不同编码器的比较，请参阅：比较目标编码器与其他编码器。

0.20 版本新增。

参数:

categories‘auto’ 或 array-like 列表，默认值为 ‘auto’

每个特征的类别（唯一值）。

‘auto’：从训练数据中自动确定类别。
list：categories[i] 包含第 i 列中预期的类别。传递的类别不应混合字符串和数值，并且在为数值的情况下应进行排序。

所使用的类别可以在 categories_ 属性中找到。

dtype数值类型，默认值为 np.float64

输出所需的 dtype。

handle_unknown{‘error’, ‘use_encoded_value’}，默认值为 ‘error’

当设置为 ‘error’ 时，如果在转换过程中存在未知分类特征，则会引发错误。当设置为 ‘use_encoded_value’ 时，未知类别的编码值将设置为参数 unknown_value 给定的值。在 inverse_transform 中，未知类别将表示为 None。

0.24 版本新增。

unknown_valueint 或 np.nan，默认值为 None

当参数 handle_unknown 设置为 ‘use_encoded_value’ 时，此参数是必需的，并将设置未知类别的编码值。它必须与用于编码 fit 中任何类别的整数值不同。如果设置为 np.nan，则 dtype 参数必须是浮点 dtype。

0.24 版本新增。

encoded_missing_valueint 或 np.nan，默认值为 np.nan

缺失类别的编码值。如果设置为 np.nan，则 dtype 参数必须是浮点 dtype。

版本 1.1 中新增。

min_frequencyint 或 float，默认值为 None

指定类别被视为不常见的最小频率。

如果为 int，则基数较小的类别将被视为不常见。
如果为 float，则基数小于 min_frequency * n_samples 的类别将被视为不常见。

版本 1.3 中新增：在用户指南中了解更多信息。

max_categoriesint，默认值为 None

指定在考虑不常见类别时，每个输入特征的输出类别数量的上限。如果存在不常见类别，max_categories 包括表示不常见类别的类别以及常见类别。如果为 None，则对输出特征的数量没有限制。

max_categories 不考虑缺失或未知类别。将 unknown_value 或 encoded_missing_value 设置为整数将使唯一整数代码的数量分别增加 1。这可能导致最多 max_categories + 2 个整数代码。

版本 1.3 中新增：在用户指南中了解更多信息。

属性:

categories_数组列表: 在 fit 期间确定的每个特征的类别（按 X 中特征的顺序排列，与 transform 的输出相对应）。这不包括在 fit 期间未见过的类别。
n_features_in_int: 在拟合期间看到的特征数。

1.0 版本新增。
feature_names_in_shape 为 (n_features_in_,) 的 ndarray: 在 fit 期间看到的特征名称。仅当 X 具有全部为字符串的特征名称时才定义。

1.0 版本新增。
infrequent_categories_ndarray 列表: 每个特征的不常见类别。

另请参阅

OneHotEncoder: 对分类特征执行独热编码。此编码适用于低到中等基数的分类变量，无论是在监督还是非监督设置中。
TargetEncoder: 在分类或回归管线中使用监督信号对分类特征进行编码。此编码通常适用于高基数的分类变量。
LabelEncoder: 将目标标签编码为 0 到 n_classes-1 之间的值。

示例

给定一个具有两个特征的数据集，我们让编码器找到每个特征的唯一值，并将数据转换为序数编码。

>>> from sklearn.preprocessing import OrdinalEncoder
>>> enc = OrdinalEncoder()
>>> X = [['Male', 1], ['Female', 3], ['Female', 2]]
>>> enc.fit(X)
OrdinalEncoder()
>>> enc.categories_
[array(['Female', 'Male'], dtype=object), array([1, 2, 3], dtype=object)]
>>> enc.transform([['Female', 3], ['Male', 1]])
array([[0., 2.],
       [1., 0.]])

>>> enc.inverse_transform([[1, 0], [0, 1]])
array([['Male', 1],
       ['Female', 2]], dtype=object)

默认情况下，OrdinalEncoder 对缺失值持宽容态度，通过传播它们。

>>> import numpy as np
>>> X = [['Male', 1], ['Female', 3], ['Female', np.nan]]
>>> enc.fit_transform(X)
array([[ 1.,  0.],
       [ 0.,  1.],
       [ 0., nan]])

您可以使用参数 encoded_missing_value 对缺失值进行编码。

>>> enc.set_params(encoded_missing_value=-1).fit_transform(X)
array([[ 1.,  0.],
       [ 0.,  1.],
       [ 0., -1.]])

通过设置 max_categories 或 min_frequency 来启用不常见类别。在以下示例中，“a”和“d”被视为不常见并分组为一个类别，“b”和“c”是它们自己的类别，未知值编码为 3，缺失值编码为 4。

>>> X_train = np.array(
...     [["a"] * 5 + ["b"] * 20 + ["c"] * 10 + ["d"] * 3 + [np.nan]],
...     dtype=object).T
>>> enc = OrdinalEncoder(
...     handle_unknown="use_encoded_value", unknown_value=3,
...     max_categories=3, encoded_missing_value=4)
>>> _ = enc.fit(X_train)
>>> X_test = np.array([["a"], ["b"], ["c"], ["d"], ["e"], [np.nan]], dtype=object)
>>> enc.transform(X_test)
array([[2.],
       [0.],
       [1.],
       [2.],
       [3.],
       [4.]])

fit(X, y=None)[source]#

将 OrdinalEncoder 与 X 拟合。

参数:

Xshape 为 (n_samples, n_features) 的 array-like: 用于确定每个特征类别的数据。
yNone: 忽略。此参数仅用于与 Pipeline 的兼容性。

返回:

selfobject: 已拟合的编码器。

fit_transform(X, y=None, **fit_params)[source]#

拟合数据，然后对其进行转换。

使用可选参数 fit_params 将转换器拟合到 X 和 y，并返回 X 的转换版本。

参数:

Xshape 为 (n_samples, n_features) 的 array-like: 输入样本。
y形状为 (n_samples,) 或 (n_samples, n_outputs) 的类数组对象，默认=None: 目标值（对于无监督转换，为 None）。
**fit_paramsdict: 额外的拟合参数。仅当估计器在其 fit 方法中接受额外的参数时才传递。

返回:

X_newndarray array of shape (n_samples, n_features_new): 转换后的数组。

get_feature_names_out(input_features=None)[source]#

获取转换的输出特征名称。

参数:

input_featuresarray-like of str or None, default=None

输入特征。

如果 input_features 为 None，则使用 feature_names_in_ 作为输入特征名称。如果 feature_names_in_ 未定义，则生成以下输入特征名称：["x0", "x1", ..., "x(n_features_in_ - 1)"]。
如果 input_features 是 array-like，则如果定义了 feature_names_in_，input_features 必须与 feature_names_in_ 匹配。

返回:

feature_names_outstr 对象的 ndarray: 与输入特征相同。

get_metadata_routing()[source]#

获取此对象的元数据路由。

请查阅用户指南，了解路由机制如何工作。

返回:

routingMetadataRequest: 封装路由信息的 MetadataRequest。

get_params(deep=True)[source]#

获取此估计器的参数。

参数:

deepbool, default=True: 如果为 True，将返回此估计器以及包含的子对象（如果它们是估计器）的参数。

返回:

paramsdict: 参数名称映射到其值。

inverse_transform(X)[source]#

将数据转换回原始表示。

参数:

X形状为 (n_samples, n_encoded_features) 的类数组: 转换后的数据。

返回:

X_original形状为 (n_samples, n_features) 的 ndarray: 逆转换后的数组。

set_output(*, transform=None)[source]#

设置输出容器。

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

参数:

transform{“default”, “pandas”, “polars”}, default=None

配置 transform 和 fit_transform 的输出。

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

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

返回:

selfestimator instance: 估计器实例。

set_params(**params)[source]#

设置此估计器的参数。

此方法适用于简单的估计器以及嵌套对象（如 Pipeline）。后者具有 <component>__<parameter> 形式的参数，以便可以更新嵌套对象的每个组件。

参数:

**paramsdict: 估计器参数。

返回:

selfestimator instance: 估计器实例。

transform(X)[source]#

将 X 转换为序数代码。

参数:

Xshape 为 (n_samples, n_features) 的 array-like: 要编码的数据。

返回:

X_out形状为 (n_samples, n_features) 的 ndarray: 转换后的输入。

Gallery examples#

梯度提升中的分类特征支持

使用堆叠组合预测器

部分依赖和个体条件期望图

排列重要性 vs 随机森林特征重要性（MDI）

泊松回归和非正态损失

离群点检测估计器的评估

比较目标编码器与其他编码器

scikit-learn 1.2 发布亮点

scikit-learn 1.3 发布亮点

OrdinalEncoder#

Gallery examples#

本页