pairwise_distances_chunked#

sklearn.metrics.pairwise_distances_chunked(X, Y=None, *, reduce_func=None, metric='euclidean', n_jobs=None, working_memory=None, **kwds)#

生成一个分块的距离矩阵，可选的归约操作。

在不需要一次性存储所有成对距离矩阵的情况下，这用于计算成对距离的 working_memory 大小的块。如果给出了 reduce_func ，它会在每个块上运行，并且其返回值会被连接成列表、数组或稀疏矩阵。

Parameters:
X{array-like, sparse matrix} 形状为 (n_samples_X, n_samples_X) 或 (n_samples_X, n_features)

样本之间的成对距离数组，或特征数组。如果 metric=’precomputed’，数组的形状应为 (n_samples_X, n_samples_X)，否则应为 (n_samples_X, n_features)。

Y{array-like, sparse matrix} 形状为 (n_samples_Y, n_features)，默认=None

可选的第二个特征数组。仅在 metric != “precomputed” 时允许。

reduce_funccallable, 默认=None

在每个距离矩阵块上应用的函数，将其归约为需要的值。 reduce_func(D_chunk, start) 会被重复调用，其中 D_chunk 是成对距离矩阵的连续垂直切片，从行 start 开始。它应返回以下之一：None；长度为 D_chunk.shape[0] 的数组、列表或稀疏矩阵；或这些对象的元组。返回 None 对于就地操作而不是归约操作很有用。

如果为 None，pairwise_distances_chunked 返回距离矩阵垂直块的生成器。

metricstr 或 callable, 默认=’euclidean’

在特征数组中的实例之间计算距离时使用的度量。如果 metric 是字符串，它必须是 scipy.spatial.distance.pdist 的 metric 参数允许的选项之一，或者是 pairwise.PAIRWISE_DISTANCE_FUNCTIONS 中列出的度量。如果 metric 是 “precomputed”，则假定 X 是距离矩阵。或者，如果 metric 是可调用函数，它会在每对实例（行）上调用，并记录返回值。可调用函数应接受 X 中的两个数组作为输入，并返回表示它们之间距离的值。

n_jobsint, 默认=None

用于计算的作业数。这通过将成对矩阵分解为 n_jobs 个均匀切片并在并行中计算它们来工作。

None 表示 1，除非在 joblib.parallel_backend 上下文中。 -1 表示使用所有处理器。有关更多详细信息，请参阅 Glossary 。

working_memoryfloat, 默认=None

寻求的临时距离矩阵块的最大内存。当为 None（默认）时，使用 sklearn.get_config()['working_memory'] 的值。

**kwds可选的关键字参数

任何进一步的参数都会直接传递给距离函数。如果使用 scipy.spatial.distance 度量，参数仍然是度量依赖的。请参阅 scipy 文档以获取使用示例。

Yields:
D_chunk{ndarray, sparse matrix}

距离矩阵的连续切片，可选地由 reduce_func 处理。

Examples

没有 reduce_func:

>>> import numpy as np
>>> from sklearn.metrics import pairwise_distances_chunked
>>> X = np.random.RandomState(0).rand(5, 3)
>>> D_chunk = next(pairwise_distances_chunked(X))
>>> D_chunk
array([[0.  ..., 0.29..., 0.41..., 0.19..., 0.57...],
       [0.29..., 0.  ..., 0.57..., 0.41..., 0.76...],
       [0.41..., 0.57..., 0.  ..., 0.44..., 0.90...],
       [0.19..., 0.41..., 0.44..., 0.  ..., 0.51...],
       [0.57..., 0.76..., 0.90..., 0.51..., 0.  ...]])

检索所有在半径 r 内的邻居并计算平均距离：

>>> r = .2
>>> def reduce_func(D_chunk, start):
...     neigh = [np.flatnonzero(d < r) for d in D_chunk]
...     avg_dist = (D_chunk * (D_chunk < r)).mean(axis=1)
...     return neigh, avg_dist
>>> gen = pairwise_distances_chunked(X, reduce_func=reduce_func)
>>> neigh, avg_dist = next(gen)
>>> neigh
[array([0, 3]), array([1]), array([2]), array([0, 3]), array([4])]
>>> avg_dist
array([0.039..., 0.        , 0.        , 0.039..., 0.        ])

其中 r 是按样本定义的，我们需要利用 start ：

>>> r = [.2, .4, .4, .3, .1]
>>> def reduce_func(D_chunk, start):
...     neigh = [np.flatnonzero(d < r[i])
...              for i, d in enumerate(D_chunk, start)]
...     return neigh
>>> neigh = next(pairwise_distances_chunked(X, reduce_func=reduce_func))
>>> neigh
[array([0, 3]), array([0, 1]), array([2]), array([0, 3]), array([4])]

通过减少 working_memory 强制逐行生成：

>>> gen = pairwise_distances_chunked(X, reduce_func=reduce_func,
...                                  working_memory=0)
>>> next(gen)
[array([0, 3])]
>>> next(gen)
[array([0, 1])]
On this page
Show Source