OneHotEncoder#

class sklearn.preprocessing.OneHotEncoder(*, categories='auto', drop=None, sparse_output=True, dtype=<class 'numpy.float64'>, handle_unknown='error', min_frequency=None, max_categories=None, feature_name_combiner='concat')#

将分类特征编码为独热数值数组。

该转换器的输入应为整数或字符串的类数组，表示分类（离散）特征的取值。特征使用独热（即“K中之一”或“哑变量”）编码方案进行编码。这将创建每个类别的二进制列，并返回稀疏矩阵或密集数组（取决于 sparse_output 参数）。

默认情况下，编码器根据每个特征中的唯一值推导类别。或者，您也可以手动指定 categories 。

这种编码对于将分类数据提供给许多scikit-learn估计器是必需的，特别是线性模型和具有标准内核的SVM。

注意：y标签的独热编码应使用LabelBinarizer代替。

更多信息请参阅：ref:User Guide <preprocessing_categorical_features> 。有关不同编码器的比较，请参阅：ref:sphx_glr_auto_examples_preprocessing_plot_target_encoder.py 。

Parameters:

categories‘auto’ 或类数组列表, 默认=’auto’

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

‘auto’ : 根据训练数据自动确定类别。
列表 :categories[i] 包含第i列中预期的类别。传递的类别不应在单个特征中混合字符串和数值，并且在数值情况下应排序。

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

Added in version 0.20.

drop{‘first’, ‘if_binary’} 或形状为 (n_features,) 的类数组, 默认=None

指定一种方法来删除每个特征中的一个类别。这在完全共线特征导致问题的情况下非常有用，例如将结果数据输入到未正则化的线性回归模型时。

然而，删除一个类别会破坏原始表示的对称性，并因此可能在下游模型中引入偏差，例如对于惩罚线性分类或回归模型。

None : 保留所有特征（默认）。
‘first’ : 删除每个特征中的第一个类别。如果只有一个类别存在，则该特征将被完全删除。
‘if_binary’ : 删除每个具有两个类别的特征中的第一个类别。具有1个或超过2个类别的特征将保持不变。
数组 :drop[i] 是特征 X[:, i] 中应删除的类别。

当 max_categories 或 min_frequency 配置为分组不频繁类别时，删除行为在分组后处理。

Added in version 0.21: 参数 drop 在0.21中添加。

Changed in version 0.23: 选项 drop='if_binary' 在0.23中添加。

Changed in version 1.1: 支持删除不频繁类别。

sparse_outputbool, 默认=True

当 True 时，返回 scipy.sparse.csr_matrix ，即“压缩稀疏行”（CSR）格式的稀疏矩阵。

Added in version 1.2: sparse 重命名为 sparse_output

dtype数值类型, 默认=np.float64

期望的输出数据类型。

handle_unknown{‘error’, ‘ignore’, ‘infrequent_if_exist’}, 默认=’error’

指定在 transform 期间处理未知类别的方式。

‘error’ : 如果在转换期间遇到未知类别，则引发错误。
‘ignore’ : 如果在转换期间遇到未知类别，则该特征的独热编码列将全为零。在逆转换中，未知类别将表示为None。
‘infrequent_if_exist’ : 如果在转换期间遇到未知类别，则该特征的独热编码列将映射到不频繁类别（如果存在）。不频繁类别将映射到编码中的最后一个位置。在逆转换期间，未知类别将映射到表示为 'infrequent' 的类别（如果存在）。如果 'infrequent' 类别不存在，则 transform 和 inverse_transform 将像 handle_unknown='ignore' 一样处理未知类别。不频繁类别基于 min_frequency 和 max_categories 存在。更多信息请参阅：ref:User Guide <encoder_infrequent_categories> 。

Changed in version 1.1: 添加 'infrequent_if_exist' 以自动处理未知类别和不频繁类别。

min_frequencyint 或 float, 默认=None

指定低于该频率的类别将被视为不频繁。

如果 int ，类别具有较小的基数将被视为不频繁。
如果 float ，类别具有小于 min_frequency * n_samples 的基数将被视为不频繁。

Added in version 1.1: 更多信息请参阅：ref:User Guide <encoder_infrequent_categories> 。

max_categoriesint, 默认=None

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

Added in version 1.1: 更多信息请参阅：ref:User Guide <encoder_infrequent_categories> 。

feature_name_combiner“concat” 或 callable, 默认=”concat”

具有签名 def callable(input_feature, category) 的callable，返回一个字符串。这用于创建由 get_feature_names_out 返回的特征名称。

"concat" 用 feature + "_" + str(category) 连接编码的特征名称和类别。例如，特征 X 具有值 1, 6, 7 创建特征名称 X_1, X_6, X_7 。

Added in version 1.3.

Attributes:

categories_数组列表

每个特征的类别在拟合期间确定（按X中特征的顺序，对应于 transform 的输出）。这包括在 drop 中指定的类别（如果有）。

drop_idx_形状为 (n_features,) 的数组

drop_idx_[i] 是 categories_[i] 中每个特征应删除的类别的索引。
drop_idx_[i] = None 如果特征索引 i 没有类别要删除，例如当 drop='if_binary' 且特征不是二进制时。
drop_idx_ = None 如果所有转换的特征将被保留。

如果通过设置 min_frequency 或 max_categories 启用不频繁类别，并且 drop_idx[i] 对应于不频繁类别，则整个不频繁类别将被删除。

Changed in version 0.23: 添加包含 None 值的可能性。

infrequent_categories_数组列表

稀有类别对于每个特征。

n_features_in_int

在 fit 期间看到的特征数量。

Added in version 1.0.

feature_names_in_形状为 ( n_features_in_ ,) 的 ndarray

在 fit 期间看到的特征名称。仅当 X 具有全部为字符串的特征名称时定义。

Added in version 1.0.

feature_name_combinercallable 或 None

具有签名 def callable(input_feature, category) 的callable，返回一个字符串。这用于创建由 get_feature_names_out 返回的特征名称。

Added in version 1.3.

See also

OrdinalEncoder: 对分类特征执行序数（整数）编码。
TargetEncoder: 使用目标对分类特征进行编码。
sklearn.feature_extraction.DictVectorizer: 对字典项执行独热编码（还处理字符串值特征）。
sklearn.feature_extraction.FeatureHasher: 对字典项或字符串执行近似独热编码。
LabelBinarizer: 以一对多的方式对标签进行二值化。
MultiLabelBinarizer: 在可迭代对象的可迭代对象和多标签格式之间转换，例如表示类标签存在的 (samples x classes) 二进制矩阵。

Examples

给定一个包含两个特征的数据集，我们让编码器找到每个特征的唯一值，并将数据转换为二进制独热编码。

>>> from sklearn.preprocessing import OneHotEncoder

可以丢弃在 fit 期间未见过的类别：

>>> enc = OneHotEncoder(handle_unknown='ignore')
>>> X = [['Male', 1], ['Female', 3], ['Female', 2]]
>>> enc.fit(X)
OneHotEncoder(handle_unknown='ignore')
>>> enc.categories_
[array(['Female', 'Male'], dtype=object), array([1, 2, 3], dtype=object)]
>>> enc.transform([['Female', 1], ['Male', 4]]).toarray()
array([[1., 0., 1., 0., 0.],
       [0., 1., 0., 0., 0.]])
>>> enc.inverse_transform([[0, 1, 1, 0, 0], [0, 0, 0, 1, 0]])
array([['Male', 1],
       [None, 2]], dtype=object)
>>> enc.get_feature_names_out(['gender', 'group'])
array(['gender_Female', 'gender_Male', 'group_1', 'group_2', 'group_3'], ...)

可以始终为每个特征删除第一列：

>>> drop_enc = OneHotEncoder(drop='first').fit(X)
>>> drop_enc.categories_
[array(['Female', 'Male'], dtype=object), array([1, 2, 3], dtype=object)]
>>> drop_enc.transform([['Female', 1], ['Male', 2]]).toarray()
array([[0., 0., 0.],
       [1., 1., 0.]])

或者只为具有2个类别的特征删除一列：

>>> drop_binary_enc = OneHotEncoder(drop='if_binary').fit(X)
>>> drop_binary_enc.transform([['Female', 1], ['Male', 2]]).toarray()
array([[0., 1., 0., 0.],
       [1., 0., 1., 0.]])

可以更改特征名称的创建方式。

>>> def custom_combiner(feature, category):
...     return str(feature) + "_" + type(category).__name__ + "_" + str(category)
>>> custom_fnames_enc = OneHotEncoder(feature_name_combiner=custom_combiner).fit(X)
>>> custom_fnames_enc.get_feature_names_out()
array(['x0_str_Female', 'x0_str_Male', 'x1_int_1', 'x1_int_2', 'x1_int_3'],
      dtype=object)

通过设置 max_categories 或 min_frequency 启用不频繁类别。

>>> import numpy as np
>>> X = np.array([["a"] * 5 + ["b"] * 20 + ["c"] * 10 + ["d"] * 3], dtype=object).T
>>> ohe = OneHotEncoder(max_categories=3, sparse_output=False).fit(X)
>>> ohe.infrequent_categories_
[array(['a', 'd'], dtype=object)]
>>> ohe.transform([["a"], ["b"]])
array([[0., 0., 1.],
       [1., 0., 0.]])

fit(X, y=None)#

拟合OneHotEncoder到X。

Parameters:

Xarray-like of shape (n_samples, n_features): 用于确定每个特征类别的数据。
yNone: 忽略。此参数仅为与 Pipeline 兼容而存在。

Returns:

self: 拟合后的编码器。

fit_transform(X, y=None, **fit_params)#

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

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

Parameters:

X形状为 (n_samples, n_features) 的类数组: 输入样本。
y形状为 (n_samples,) 或 (n_samples, n_outputs) 的类数组, 默认=None: 目标值（无监督转换为 None）。
**fit_paramsdict: 其他拟合参数。

Returns:

X_new形状为 (n_samples, n_features_new) 的 ndarray 数组: 转换后的数组。

get_feature_names_out(input_features=None)#

获取变换后的输出特征名称。

Parameters:

input_features字符串数组或None，默认=None

输入特征。

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

Returns: