Birch#

class sklearn.cluster.Birch(*, threshold=0.5, branching_factor=50, n_clusters=3, compute_labels=True)[source]#

实现 BIRCH 聚类算法。

它是一种内存高效的在线学习算法，作为 MiniBatchKMeans 的替代方案提供。它构建了一个树形数据结构，其聚类质心从叶子中读取。这些可以是最终的聚类质心，也可以作为输入提供给另一种聚类算法，例如 AgglomerativeClustering。

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

在版本 0.16 中新增。

参数:
thresholdfloat, default=0.5

通过合并新样本和最近的子聚类获得的子聚类半径应小于阈值。否则将开始一个新的子聚类。将此值设置得非常低会促进分裂，反之亦然。

branching_factorint, default=50

每个节点中 CF 子聚类的最大数量。如果新样本进入导致子聚类数量超过 branching_factor，则该节点将分裂成两个节点，子聚类在其中重新分配。该节点的父子聚类被移除，两个新的子聚类作为这两个分裂节点的父节点被添加。

n_clustersint, sklearn.cluster model 实例或 None, default=3

最终聚类步骤后的聚类数量，该步骤将叶子中的子聚类视为新样本。

  • None：不执行最终聚类步骤，子聚类按原样返回。

  • sklearn.cluster Estimator：如果提供了模型，则将子聚类视为新样本拟合模型，并将初始数据映射到最近子聚类的标签。

  • int：拟合的模型是 AgglomerativeClustering，其中 n_clusters 设置为该整数。

compute_labelsbool, default=True

是否为每次拟合计算标签。

属性:
root__CFNode

CFTree 的根节点。

dummy_leaf__CFNode

所有叶子的起始指针。

subcluster_centers_ndarray

直接从叶子读取的所有子聚类的质心。

subcluster_labels_ndarray

子聚类在全局聚类后分配给其质心的标签。

labels_ndarray of shape (n_samples,)

分配给输入数据的标签数组。如果使用 partial_fit 而不是 fit，则将其分配给最后一批数据。

n_features_in_int

在 拟合 期间看到的特征数。

0.24 版本新增。

feature_names_in_shape 为 (n_features_in_,) 的 ndarray

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

1.0 版本新增。

另请参阅

MiniBatchKMeans

使用 mini-batches 对中心位置进行增量更新的替代实现。

注意事项

树形数据结构由节点组成，每个节点包含多个子聚类。节点中子聚类的最大数量由分支因子确定。每个子聚类维护一个线性总和、平方总和以及该子聚类中的样本数量。此外，如果子聚类不是叶节点的成员，它还可以将一个节点作为其子节点。

对于进入根节点的新点，它会与其最近的子聚类合并，并更新该子聚类的线性总和、平方总和和样本数量。这个过程递归进行，直到叶节点的属性被更新。

有关与 MiniBatchKMeans 的比较，请参阅 比较 BIRCH 和 MiniBatchKMeans。

References

示例

>>> from sklearn.cluster import Birch
>>> X = [[0, 1], [0.3, 1], [-0.3, 1], [0, -1], [0.3, -1], [-0.3, -1]]
>>> brc = Birch(n_clusters=None)
>>> brc.fit(X)
Birch(n_clusters=None)
>>> brc.predict(X)
array([0, 0, 0, 1, 1, 1])

有关 BIRCH 聚类算法与其他聚类算法的比较，请参阅 比较玩具数据集上的不同聚类算法

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

为输入数据构建 CF 树。

参数:
Xshape 为 (n_samples, n_features) 的 {array-like, sparse matrix}

Input data.

y被忽略

Not used, present here for API consistency by convention.

返回:
self

拟合的估计器。

fit_predict(X, y=None, **kwargs)[source]#

对 X 执行聚类并返回聚类标签。

参数:
Xshape 为 (n_samples, n_features) 的 array-like

Input data.

y被忽略

未使用，按照惯例为保持 API 一致性而存在。

**kwargsdict

要传递给 fit 的参数。

1.4 版本新增。

返回:
labels形状为 (n_samples,) 的 ndarray，dtype=np.int64

聚类标签。

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]#

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

The feature names out will prefixed by the lowercased class name. For example, if the transformer outputs 3 features, then the feature names out are: ["class_name0", "class_name1", "class_name2"].

参数:
input_featuresarray-like of str or None, default=None

Only used to validate feature names with the names seen in fit.

返回:
feature_names_outstr 对象的 ndarray

转换后的特征名称。

get_metadata_routing()[source]#

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

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

返回:
routingMetadataRequest

封装路由信息的 MetadataRequest。

get_params(deep=True)[source]#

获取此估计器的参数。

参数:
deepbool, default=True

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

返回:
paramsdict

参数名称映射到其值。

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

在线学习。防止从头开始重建 CFTree。

参数:
X{array-like, sparse matrix} of shape (n_samples, n_features), default=None

输入数据。如果未提供 X，则仅执行全局聚类步骤。

y被忽略

Not used, present here for API consistency by convention.

返回:
self

拟合的估计器。

predict(X)[source]#

使用子聚类的 centroids_ 预测数据。

避免计算 X 的行范数。

参数:
Xshape 为 (n_samples, n_features) 的 {array-like, sparse matrix}

Input data.

返回:
labelsndarray of shape(n_samples,)

标记的数据。

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, sparse matrix}

Input data.

返回:
X_trans{array-like, sparse matrix} of shape (n_samples, n_clusters)

转换后的数据。