MiniBatchDictionaryLearning#

class sklearn.decomposition.MiniBatchDictionaryLearning(n_components=None, *, alpha=1, max_iter=1000, fit_algorithm='lars', n_jobs=None, batch_size=256, shuffle=True, dict_init=None, transform_algorithm='omp', transform_n_nonzero_coefs=None, transform_alpha=None, verbose=False, split_sign=False, random_state=None, positive_code=False, positive_dict=False, transform_max_iter=1000, callback=None, tol=0.001, max_no_improvement=10)#

Mini-batch 字典学习。

找到一个字典（一组原子），能够很好地稀疏编码拟合的数据。

解决优化问题:

(U^*,V^*) = argmin 0.5 || X - U V ||_Fro^2 + alpha * || U ||_1,1
             (U,V)
             with || V_k ||_2 <= 1 for all  0 <= k < n_components

||.||_Fro 表示 Frobenius 范数，||.||_1,1 表示逐元素矩阵范数，即矩阵中所有元素绝对值之和。

更多信息请参阅 用户指南 。

Parameters:
n_componentsint, default=None

要提取的字典元素数量。

alphafloat, default=1

稀疏控制参数。

max_iterint, default=1_000

在停止之前对整个数据集的最大迭代次数，独立于任何提前停止标准的启发式方法。

Added in version 1.1.

Deprecated since version 1.4: max_iter=None 在 1.4 中已弃用，并将在 1.6 中移除。请使用默认值（即 1_000 ）。

fit_algorithm{‘lars’, ‘cd’}, default=’lars’

使用的算法：

  • 'lars' ：使用最小角回归方法解决 lasso 问题（ linear_model.lars_path ）

  • 'cd' ：使用坐标下降法计算 Lasso 解决方案（ linear_model.Lasso ）。如果估计的组件是稀疏的，Lars 会更快。

n_jobsint, default=None

并行运行的作业数量。 None 表示 1，除非在 joblib.parallel_backend 上下文中。 -1 表示使用所有处理器。更多细节请参见 Glossary 。

batch_sizeint, default=256

每个 mini-batch 中的样本数量。

Changed in version 1.3: 在版本 1.3 中， batch_size 的默认值从 3 改为 256。

shufflebool, default=True

在形成批次之前是否打乱样本。

dict_initndarray of shape (n_components, n_features), default=None

用于热重启场景的字典初始值。

transform_algorithm{‘lasso_lars’, ‘lasso_cd’, ‘lars’, ‘omp’, ‘threshold’}, default=’omp’

用于转换数据的算法：

  • 'lars' ：使用最小角回归方法（ linear_model.lars_path ）；

  • 'lasso_lars' ：使用 Lars 计算 Lasso 解决方案。

  • 'lasso_cd' ：使用坐标下降法计算 Lasso 解决方案（ linear_model.Lasso ）。如果估计的组件是稀疏的， 'lasso_lars' 会更快。

  • 'omp' ：使用正交匹配追踪估计稀疏解决方案。

  • 'threshold' ：将投影 dictionary * X' 中绝对值小于 alpha 的所有系数压缩为零。

transform_n_nonzero_coefsint, default=None

每个解决方案列中目标的非零系数数量。这仅在 algorithm='lars' 和 algorithm='omp' 时使用。如果 None ，则 transform_n_nonzero_coefs=int(n_features / 10) 。

transform_alphafloat, default=None

如果 algorithm='lasso_lars' 或 algorithm='lasso_cd' ， alpha 是应用于 L1 范数的惩罚。 如果 algorithm='threshold' ， alpha 是绝对值阈值，低于该阈值的系数将被压缩为零。 如果 None ，默认为 alpha 。

Changed in version 1.2: 当 None 时，默认值从 1.0 改为 alpha 。

verbosebool or int, default=False

控制过程的详细程度。

split_signbool, default=False

是否将稀疏特征向量拆分为其负部分和正部分的连接。这可以提高下游分类器的性能。

random_stateint, RandomState instance or None, default=None

用于在未指定 dict_init 时初始化字典，在 shuffle 设置为 True 时随机打乱数据，以及更新字典。传递一个 int 以在多次函数调用中获得可重复的结果。更多细节请参见 Glossary 。

positive_codebool, default=False

在找到代码时是否强制正性。

Added in version 0.20.

positive_dictbool, default=False

在找到字典时是否强制正性。

Added in version 0.20.

transform_max_iterint, default=1000

如果 algorithm='lasso_cd' 或 'lasso_lars' ，执行的最大迭代次数。

Added in version 0.22.

callbackcallable, default=None

在每次迭代结束时调用的可调用对象。

Added in version 1.1.

tolfloat, default=1e-3

基于字典在两个步骤之间的差异范数控制提前停止。

要禁用基于字典变化的提前停止，请将 tol 设置为 0.0。

Added in version 1.1.

max_no_improvementint, default=10

基于连续的 mini-batch 数量控制提前停止，这些 mini-batch 没有在平滑成本函数上产生改进。

要禁用基于成本函数的收敛检测，请将 max_no_improvement 设置为 None。

Added in version 1.1.

Attributes:
components_ndarray of shape (n_components, n_features)

从数据中提取的组件。

n_features_in_int

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

Added in version 0.24.

feature_names_in_ndarray of shape ( n_features_in_ ,)

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

Added in version 1.0.

n_iter_int

对整个数据集的迭代次数。

n_steps_int

处理的 mini-batch 数量。

Added in version 1.1.

See also

DictionaryLearning

找到一个稀疏编码数据的字典。

MiniBatchSparsePCA

Mini-batch 稀疏主成分分析。

SparseCoder

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

SparsePCA

稀疏主成分分析。

References

J. Mairal, F. Bach, J. Ponce, G. Sapiro, 2009: Online dictionary learning for sparse coding (https://www.di.ens.fr/sierra/pdfs/icml09.pdf)

Examples

>>> import numpy as np
>>> from sklearn.datasets import make_sparse_coded_signal
>>> from sklearn.decomposition import MiniBatchDictionaryLearning
>>> X, dictionary, code = make_sparse_coded_signal(
...     n_samples=30, n_components=15, n_features=20, n_nonzero_coefs=10,
...     random_state=42)
>>> dict_learner = MiniBatchDictionaryLearning(
...     n_components=15, batch_size=3, transform_algorithm='lasso_lars',
...     transform_alpha=0.1, max_iter=20, random_state=42)
>>> X_transformed = dict_learner.fit_transform(X)

我们可以检查 X_transformed 的稀疏程度：

>>> np.mean(X_transformed == 0) > 0.5
True

我们可以比较稀疏编码信号的重构误差的平均平方欧几里得范数与原始信号的平方欧几里得范数：

>>> X_hat = X_transformed @ dict_learner.components_
>>> np.mean(np.sum((X_hat - X) ** 2, axis=1) / np.sum(X ** 2, axis=1))
0.052...
fit(X, y=None)#

拟合从数据X中的模型。

Parameters:
X形状为 (n_samples, n_features) 的类数组

训练向量，其中 n_samples 是样本的数量 且 n_features 是特征的数量。

y忽略

未使用，为了API一致性而存在。

Returns:
selfobject

返回实例本身。

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

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

输出特征名称将以小写的类名作为前缀。例如，如果转换器输出3个特征，那么输出特征名称将是： ["class_name0", "class_name1", "class_name2"] 。

Parameters:
input_features类似数组的对象或None，默认为None

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

Returns:
feature_names_outndarray of str对象

转换后的特征名称。

get_metadata_routing()#

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

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

Returns:
routingMetadataRequest

MetadataRequest 封装的 路由信息。

get_params(deep=True)#

获取此估计器的参数。

Parameters:
deepbool, 默认=True

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

Returns:
paramsdict

参数名称映射到它们的值。

partial_fit(X, y=None)#

更新模型，使用X中的数据作为小批量。

Parameters:
X形状为 (n_samples, n_features) 的类数组

训练向量，其中 n_samples 是样本的数量 而 n_features 是特征的数量。

y忽略

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

Returns:
self对象

返回实例本身。

set_output(*, transform=None)#

设置输出容器。

请参阅 介绍 set_output API 以了解如何使用API的示例。

Parameters:
transform{“default”, “pandas”, “polars”}, 默认=None

配置 transform 和 fit_transform 的输出。

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

  • "pandas" : DataFrame 输出

  • "polars" : Polars 输出

  • None : 转换配置不变

Added in version 1.4: "polars" 选项已添加。

Returns:
self估计器实例

估计器实例。

set_params(**params)#

设置此估计器的参数。

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

Parameters:
**paramsdict

估计器参数。

Returns:
selfestimator instance

估计器实例。

transform(X)#

将数据编码为字典原子的稀疏组合。

编码方法由对象参数 transform_algorithm 决定。

Parameters:
X形状为(n_samples, n_features)的ndarray

要转换的测试数据，必须与用于训练模型的数据具有相同数量的特征。

Returns:
X_new形状为(n_samples, n_components)的ndarray

转换后的数据。

On this page
Show Source