NMF#

class sklearn.decomposition.NMF(n_components='auto', *, init=None, solver='cd', beta_loss='frobenius', tol=0.0001, max_iter=200, random_state=None, alpha_W=0.0, alpha_H='same', l1_ratio=0.0, verbose=0, shuffle=False)[source]#

非负矩阵分解(NMF)。

寻找两个非负矩阵(即所有元素均非负的矩阵)(W, H),它们的乘积近似于非负矩阵 X。这种分解可用于例如降维、源分离或主题提取。

目标函数为

\[ \begin{align}\begin{aligned}L(W, H) &= 0.5 * ||X - WH||_{loss}^2\\ &+ alpha\_W * l1\_ratio * n\_features * ||vec(W)||_1\\ &+ alpha\_H * l1\_ratio * n\_samples * ||vec(H)||_1\\ &+ 0.5 * alpha\_W * (1 - l1\_ratio) * n\_features * ||W||_{Fro}^2\\ &+ 0.5 * alpha\_H * (1 - l1\_ratio) * n\_samples * ||H||_{Fro}^2,\end{aligned}\end{align} \]

其中 \(||A||_{Fro}^2 = \sum_{i,j} A_{ij}^2\)(Frobenius 范数)和 \(||vec(A)||_1 = \sum_{i,j} abs(A_{ij})\)(元素级 L1 范数)。

泛型范数 \(||X - WH||_{loss}\) 可以表示 Frobenius 范数或另一种受支持的 beta-散度损失。选项之间的选择由 beta_loss 参数控制。

W 的正则化项按 n_features 缩放,对 H 的正则化项按 n_samples 缩放,以使其影响相互平衡,并尽可能独立于训练集的大小 n_samples

目标函数通过 W 和 H 的交替最小化来最小化。

请注意,转换后的数据被命名为 W,分量矩阵被命名为 H。在 NMF 文献中,命名约定通常是相反的,因为数据矩阵 X 是转置的。

更多信息请参阅用户指南

参数:
n_componentsint 或 {‘auto’} 或 None,默认值=’auto’

分量数量。如果为 None,则保留所有特征。如果 n_components='auto',则分量数量将从 W 或 H 的形状中自动推断。

版本 1.4 中更改: 增加了 'auto' 值。

版本 1.6 中更改: 默认值从 None 更改为 'auto'

init{‘random’, ‘nndsvd’, ‘nndsvda’, ‘nndsvdar’, ‘custom’},默认值=None

用于初始化过程的方法。有效选项:

  • None:如果 n_components <= min(n_samples, n_features),则为 ‘nndsvda’,否则为 random。

  • 'random':非负随机矩阵,按 sqrt(X.mean() / n_components) 缩放。

  • 'nndsvd':非负双奇异值分解 (NNDSVD) 初始化(更适用于稀疏性)

  • 'nndsvda':NNDSVD,其中零用 X 的平均值填充(在不希望稀疏性时更好)

  • 'nndsvdar':NNDSVD,其中零用小随机值填充(通常更快,在不希望稀疏性时是 NNDSVDa 的不太准确的替代方案)

  • 'custom':使用必须同时提供的自定义矩阵 WH

版本 1.1 中更改: init=None 且 n_components 小于 n_samples 和 n_features 时,默认使用 nndsvda 而非 nndsvd

solver{‘cd’, ‘mu’},默认值=’cd’

要使用的数值求解器

  • ‘cd’ 是一个坐标下降求解器。

  • ‘mu’ 是一个乘法更新求解器。

版本 0.17 中新增: 坐标下降求解器。

版本 0.19 中新增: 乘法更新求解器。

beta_lossfloat 或 {‘frobenius’, ‘kullback-leibler’, ‘itakura-saito’},默认值=’frobenius’

要最小化的 Beta 散度,用于衡量 X 和点积 WH 之间的距离。请注意,与 ‘frobenius’(或 2)和 ‘kullback-leibler’(或 1)不同的值会导致拟合速度显著变慢。请注意,对于 beta_loss <= 0(或 ‘itakura-saito’),输入矩阵 X 不能包含零。仅在 ‘mu’ 求解器中使用。

版本 0.19 中新增。

tolfloat,默认值=1e-4

停止条件的容差。

max_iterint,默认值=200

超时前的最大迭代次数。

random_stateint, RandomState 实例或 None,默认值=None

用于初始化(当 init == ‘nndsvdar’ 或 ‘random’ 时)和坐标下降。传入一个整数可以在多次函数调用中获得可重现的结果。参见术语表

alpha_Wfloat,默认值=0.0

乘以 W 的正则化项的常数。将其设置为零(默认值)表示不对 W 进行正则化。

版本 1.0 中新增。

alpha_Hfloat 或 “same”,默认值=”same”

乘以 H 的正则化项的常数。将其设置为零表示不对 H 进行正则化。如果为 “same”(默认值),则其值与 alpha_W 相同。

版本 1.0 中新增。

l1_ratiofloat,默认值=0.0

正则化混合参数,0 <= l1_ratio <= 1。当 l1_ratio = 0 时,惩罚项是元素级 L2 惩罚(又称 Frobenius 范数)。当 l1_ratio = 1 时,惩罚项是元素级 L1 惩罚。当 0 < l1_ratio < 1 时,惩罚项是 L1 和 L2 的组合。

版本 0.17 中新增: 坐标下降求解器中使用的正则化参数 l1_ratio

verboseint,默认值=0

是否启用详细输出。

shufflebool,默认值=False

如果为 True,则在 CD 求解器中随机化坐标的顺序。

版本 0.17 中新增: 坐标下降求解器中使用的 shuffle 参数。

属性:
components_形状为 (n_components, n_features) 的 ndarray

分解矩阵,有时称为“字典”。

n_components_int

分量数量。如果 n_components 参数已给定,则与其相同。否则,将与特征数量相同。

reconstruction_err_float

训练数据 X 与拟合模型重建数据 WH 之间的矩阵差异的 Frobenius 范数,或 beta-散度。

n_iter_int

实际迭代次数。

n_features_in_int

fit 期间见到的特征数量。

版本 0.24 中新增。

feature_names_in_形状为 (n_features_in_,) 的 ndarray

fit 期间见到的特征名称。仅当 X 的所有特征名称均为字符串时才定义。

版本 1.0 中新增。

另请参阅

DictionaryLearning

查找稀疏编码数据的字典。

MiniBatchSparsePCA

小批量稀疏主成分分析。

PCA

主成分分析。

SparseCoder

从固定的预计算字典中找到数据的稀疏表示。

SparsePCA

稀疏主成分分析。

TruncatedSVD

使用截断 SVD 进行降维。

参考文献

[1]

“Fast local algorithms for large scale nonnegative matrix and tensor factorizations” Cichocki, Andrzej, and P. H. A. N. Anh-Huy. IEICE transactions on fundamentals of electronics, communications and computer sciences 92.3: 708-721, 2009.

[2]

“Algorithms for nonnegative matrix factorization with the beta-divergence” Fevotte, C., & Idier, J. (2011). Neural Computation, 23(9).

示例

>>> import numpy as np
>>> X = np.array([[1, 1], [2, 1], [3, 1.2], [4, 1], [5, 0.8], [6, 1]])
>>> from sklearn.decomposition import NMF
>>> model = NMF(n_components=2, init='random', random_state=0)
>>> W = model.fit_transform(X)
>>> H = model.components_
fit(X, y=None, **params)[source]#

为数据 X 学习一个 NMF 模型。

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

训练向量,其中 n_samples 是样本数量,n_features 是特征数量。

y忽略

未使用,根据 API 约定存在以保持一致性。

**paramskwargs

传递给 fit_transform 实例的参数(关键字参数)和值。

返回值:
selfobject

返回实例本身。

fit_transform(X, y=None, W=None, H=None)[source]#

为数据 X 学习一个 NMF 模型并返回转换后的数据。

这比先调用 fit 再调用 transform 更高效。

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

训练向量,其中 n_samples 是样本数量,n_features 是特征数量。

y忽略

未使用,根据 API 约定存在以保持一致性。

W形状为 (n_samples, n_components) 的 array-like,默认值=None

如果 init='custom',则将其用作解的初始猜测。如果为 None,则使用 init 中指定的初始化方法。

H形状为 (n_components, n_features) 的 array-like,默认值=None

如果 init='custom',则将其用作解的初始猜测。如果为 None,则使用 init 中指定的初始化方法。

返回值:
W形状为 (n_samples, n_components) 的 ndarray

转换后的数据。

get_feature_names_out(input_features=None)[source]#

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

输出特征名称将以小写类名作为前缀。例如,如果转换器输出 3 个特征,则输出特征名称为:["class_name0", "class_name1", "class_name2"]

参数:
input_featuresstr 的 array-like 或 None,默认值=None

仅用于根据 fit 中看到的名称验证特征名称。

返回值:
feature_names_outstr 对象的 ndarray

转换后的特征名称。

get_metadata_routing()[source]#

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

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

返回值:
routingMetadataRequest

一个封装路由信息的 MetadataRequest

get_params(deep=True)[source]#

获取此估计器的参数。

参数:
deepbool,默认值=True

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

返回值:
paramsdict

参数名称与其值的映射。

inverse_transform(X)[source]#

将数据转换回其原始空间。

版本 0.18 中新增。

参数:
X形状为 (n_samples, n_components) 的 {ndarray, sparse matrix}

转换后的数据矩阵。

返回值:
X_original形状为 (n_samples, n_features) 的 ndarray

返回原始形状的数据矩阵。

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

设置输出容器。

有关如何使用此 API 的示例,请参阅set_output API 简介

参数:
transform{“default”, “pandas”, “polars”},默认值=None

配置 transformfit_transform 的输出。

  • "default":转换器的默认输出格式

  • "pandas":DataFrame 输出

  • "polars":Polars 输出

  • None:转换配置未更改

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

返回值:
self估计器实例

估计器实例。

set_params(**params)[source]#

设置此估计器的参数。

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

参数:
**paramsdict

估计器参数。

返回值:
self估计器实例

估计器实例。

transform(X)[source]#

根据拟合的 NMF 模型转换数据 X。

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

训练向量,其中 n_samples 是样本数量,n_features 是特征数量。

返回值:
W形状为 (n_samples, n_components) 的 ndarray

转换后的数据。