CategoricalNB#

class sklearn.naive_bayes.CategoricalNB(*, alpha=1.0, force_alpha=True, fit_prior=True, class_prior=None, min_categories=None)[源代码]#

用于分类特征的朴素贝叶斯分类器。

分类朴素贝叶斯分类器适用于分类离散的、分类分布的特征。每个特征的类别都从分类分布中抽取。

在用户指南中阅读更多内容。

参数：
alpha浮点型，默认值=1.0

加性（Laplace/Lidstone）平滑参数（将 alpha 设置为 0 且 force_alpha 为 True 可实现无平滑）。

force_alpha布尔型，默认值=True

如果为 False 且 alpha 小于 1e-10，则会将其设置为 1e-10。如果为 True，则 alpha 将保持不变。如果 alpha 过接近 0，这可能会导致数值误差。

在 1.2 版中新增。

在 1.4 版中更改: force_alpha 的默认值已更改为 True。

fit_prior布尔型，默认值=True

是否学习类别先验概率。如果为 False，则使用均匀先验。

class_prior形状为 (n_classes,) 的类数组，默认值=None

类别的先验概率。如果指定，则先验不会根据数据进行调整。

min_categories整数或形状为 (n_features,) 的类数组，默认值=None

每个特征的最小类别数。

  • 整数：将每个特征的最小类别数设置为 n_categories。

  • 类数组：形状为 (n_features,)，其中 n_categories[i] 存储输入第 i 列的最小类别数。

  • None（默认值）：自动从训练数据中确定类别数。

在 0.24 版中新增。

属性：
category_count_形状为 (n_features,) 的数组列表

为每个特征保存形状为 (n_classes, 各自特征的 n_categories) 的数组。每个数组提供了针对特定特征的每个类别和每个类别的样本数量。

class_count_形状为 (n_classes,) 的 ndarray

拟合期间每个类别遇到的样本数量。如果提供了样本权重，此值将按样本权重加权。

class_log_prior_形状为 (n_classes,) 的 ndarray

每个类别的平滑经验对数概率。

classes_形状为 (n_classes,) 的 ndarray

分类器已知的类别标签

feature_log_prob_形状为 (n_features,) 的数组列表

为每个特征保存形状为 (n_classes, 各自特征的 n_categories) 的数组。每个数组提供了给定各自特征和类别的类别经验对数概率，即 P(x_i|y)。

n_features_in_整型

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

在 0.24 版中新增。

feature_names_in_形状为 (n_features_in_,) 的 ndarray

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

在 1.0 版中新增。

n_categories_形状为 (n_features,)，dtype=np.int64 的 ndarray

每个特征的类别数。此值从数据中推断或由最小类别数设置。

在 0.24 版中新增。

另请参见

BernoulliNB

用于多元伯努利模型的朴素贝叶斯分类器。

ComplementNB

补朴素贝叶斯分类器。

GaussianNB

高斯朴素贝叶斯。

MultinomialNB

用于多项式模型的朴素贝叶斯分类器。

示例

>>> import numpy as np
>>> rng = np.random.RandomState(1)
>>> X = rng.randint(5, size=(6, 100))
>>> y = np.array([1, 2, 3, 4, 5, 6])
>>> from sklearn.naive_bayes import CategoricalNB
>>> clf = CategoricalNB()
>>> clf.fit(X, y)
CategoricalNB()
>>> print(clf.predict(X[2:3]))
[3]
fit(X, y, sample_weight=None)[源代码]#

根据 X, y 拟合朴素贝叶斯分类器。

参数：
X形状为 (n_samples, n_features) 的 {类数组，稀疏矩阵}

训练向量，其中 n_samples 是样本数，n_features 是特征数。此处，X 的每个特征都假定来自不同的分类分布。进一步假定每个特征的所有类别都由数字 0, …, n - 1 表示，其中 n 指给定特征的总类别数。例如，这可以通过 OrdinalEncoder 来实现。

y形状为 (n_samples,) 的类数组

目标值。

sample_weight形状为 (n_samples,) 的类数组，默认值=None

应用于单个样本的权重（未加权时为 1.0）。

返回：
self对象

返回实例本身。

get_metadata_routing()[源代码]#

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

请查阅用户指南，了解路由机制的工作原理。

返回：
routingMetadataRequest

一个封装路由信息的 MetadataRequest 对象。

get_params(deep=True)[源代码]#

获取此估计器的参数。

参数：
deep布尔型，默认值=True

如果为 True，将返回此估计器及其包含的作为估计器的子对象的参数。

返回：
params字典

参数名称映射到其值。

partial_fit(X, y, classes=None, sample_weight=None)[源代码]#

对一批样本进行增量拟合。

此方法预计将在一数据集的不同数据块上连续调用多次，以实现核外学习或在线学习。

当整个数据集过大而无法一次性载入内存时，此方法特别有用。

此方法会带来一些性能开销，因此最好在尽可能大的数据块（只要在内存预算内）上调用 `partial_fit` 以隐藏开销。

参数：
X形状为 (n_samples, n_features) 的 {类数组，稀疏矩阵}

训练向量，其中 n_samples 是样本数，n_features 是特征数。此处，X 的每个特征都假定来自不同的分类分布。进一步假定每个特征的所有类别都由数字 0, …, n - 1 表示，其中 n 指给定特征的总类别数。例如，这可以通过 OrdinalEncoder 来实现。

y形状为 (n_samples,) 的类数组

目标值。

classes形状为 (n_classes,) 的类数组，默认值=None

y 向量中可能出现的所有类别列表。

必须在首次调用 `partial_fit` 时提供，后续调用中可省略。

sample_weight形状为 (n_samples,) 的类数组，默认值=None

应用于单个样本的权重（未加权时为 1.0）。

返回：
self对象

返回实例本身。

predict(X)[源代码]#

对测试向量数组 X 执行分类。

参数：
X形状为 (n_samples, n_features) 的类数组

输入样本。

返回：
C形状为 (n_samples,) 的 ndarray

X 的预测目标值。

predict_joint_log_proba(X)[源代码]#

返回测试向量 X 的联合对数概率估计。

对于 X 的每一行 x 和类别 y，联合对数概率由 log P(x, y) = log P(y) + log P(x|y) 给出，其中 log P(y) 是类别先验概率，log P(x|y) 是类别条件概率。

参数：
X形状为 (n_samples, n_features) 的类数组

输入样本。

返回：
C形状为 (n_samples, n_classes) 的 ndarray

返回模型中每个类别的样本的联合对数概率。列对应于按排序顺序排列的类别，与它们在属性 classes_ 中出现的顺序一致。

predict_log_proba(X)[源代码]#

返回测试向量 X 的对数概率估计。

参数：
X形状为 (n_samples, n_features) 的类数组

输入样本。

返回：
C形状为 (n_samples, n_classes) 的类数组

返回模型中每个类别的样本的对数概率。列对应于按排序顺序排列的类别，与它们在属性 classes_ 中出现的顺序一致。

predict_proba(X)[源代码]#

返回测试向量 X 的概率估计。

参数：
X形状为 (n_samples, n_features) 的类数组

输入样本。

返回：
C形状为 (n_samples, n_classes) 的类数组

返回模型中每个类别的样本概率。列对应于按排序顺序排列的类别，与它们在属性 classes_ 中出现的顺序一致。

score(X, y, sample_weight=None)[源代码]#

返回在提供的数据和标签上的 准确率。

在多标签分类中，这是子集准确率，这是一个严格的指标，因为它要求每个样本的每个标签集都必须被正确预测。

参数：
X形状为 (n_samples, n_features) 的类数组

测试样本。

y形状为 (n_samples,) 或 (n_samples, n_outputs) 的类数组

X 的真实标签。

sample_weight形状为 (n_samples,) 的类数组，默认值=None

样本权重。

返回：
score浮点型

相对于 y，self.predict(X) 的平均准确率。

set_fit_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → CategoricalNB[源代码]#

请求传递给 fit 方法的元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config）。请参阅用户指南，了解路由机制的工作原理。

每个参数的选项有

  • True：请求元数据，如果提供则传递给 fit。如果未提供元数据，则忽略请求。

  • False：不请求元数据，且元估计器不会将其传递给 fit。

  • None：不请求元数据，如果用户提供元数据，则元估计器将引发错误。

  • str：元数据应以给定的别名而非原始名称传递给元估计器。

默认值（sklearn.utils.metadata_routing.UNCHANGED）保留现有请求。这允许您更改部分参数的请求，而其他参数不变。

在 1.3 版中新增。

注意

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用时。否则，它不起作用。

参数：
sample_weight字符串、True、False 或 None，默认值=sklearn.utils.metadata_routing.UNCHANGED

用于 fit 方法中 sample_weight 参数的元数据路由。

返回：
self对象

更新后的对象。

set_params(**params)[源代码]#

设置此估计器的参数。

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

参数：
**params字典

估计器参数。

返回：
self估计器实例

估计器实例。

set_partial_fit_request(*, classes: bool | None | str = '$UNCHANGED$', sample_weight: bool | None | str = '$UNCHANGED$') → CategoricalNB[源代码]#

请求传递给 partial_fit 方法的元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config）。请参阅用户指南，了解路由机制的工作原理。

每个参数的选项有

  • True：请求元数据，如果提供则传递给 partial_fit。如果未提供元数据，则忽略请求。

  • False：不请求元数据，且元估计器不会将其传递给 partial_fit。

  • None：不请求元数据，如果用户提供元数据，则元估计器将引发错误。

  • str：元数据应以给定的别名而非原始名称传递给元估计器。

默认值（sklearn.utils.metadata_routing.UNCHANGED）保留现有请求。这允许您更改部分参数的请求，而其他参数不变。

在 1.3 版中新增。

注意

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用时。否则，它不起作用。

参数：
classes字符串、True、False 或 None，默认值=sklearn.utils.metadata_routing.UNCHANGED

用于 partial_fit 方法中 classes 参数的元数据路由。

sample_weight字符串、True、False 或 None，默认值=sklearn.utils.metadata_routing.UNCHANGED

用于 partial_fit 方法中 sample_weight 参数的元数据路由。

返回：
self对象

更新后的对象。

set_score_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → CategoricalNB[源代码]#

请求传递给 score 方法的元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config）。请参阅用户指南，了解路由机制的工作原理。

每个参数的选项有

  • True：请求元数据，如果提供则传递给 score。如果未提供元数据，则忽略请求。

  • False：不请求元数据，且元估计器不会将其传递给 score。

  • None：不请求元数据，如果用户提供元数据，则元估计器将引发错误。

  • str：元数据应以给定的别名而非原始名称传递给元估计器。

默认值（sklearn.utils.metadata_routing.UNCHANGED）保留现有请求。这允许您更改部分参数的请求，而其他参数不变。

在 1.3 版中新增。

注意

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用时。否则，它不起作用。

参数：
sample_weight字符串、True、False 或 None，默认值=sklearn.utils.metadata_routing.UNCHANGED

用于 score 方法中 sample_weight 参数的元数据路由。

返回：
self对象

更新后的对象。