KNeighborsTransformer#

class sklearn.neighbors.KNeighborsTransformer(*, mode='distance', n_neighbors=5, algorithm='auto', leaf_size=30, metric='minkowski', p=2, metric_params=None, n_jobs=None)#

将X转换为k个最近邻的（加权）图。

转换后的数据是由kneighbors_graph返回的稀疏图。

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

Added in version 0.22.

Parameters:

mode{‘distance’, ‘connectivity’}, default=’distance’

返回矩阵的类型：’connectivity’将返回一个由1和0组成的连通性矩阵， ‘distance’将根据给定的度量返回邻居之间的距离。

n_neighborsint, default=5

转换后的稀疏图中每个样本的邻居数量。出于兼容性原因，每个样本被视为其自身的邻居，当mode == ‘distance’时，将计算一个额外的邻居。在这种情况下，稀疏图包含(n_neighbors + 1)个邻居。

algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, default=’auto’

用于计算最近邻的算法：

‘ball_tree’将使用 BallTree
‘kd_tree’将使用 KDTree
‘brute’将使用暴力搜索。
‘auto’将尝试根据传递给 fit 方法的值决定最合适的算法。

注意：在稀疏输入上拟合将覆盖此参数的设置，使用暴力搜索。

leaf_sizeint, default=30

传递给BallTree或KDTree的叶大小。这会影响构建和查询的速度，以及存储树所需的内存。最佳值取决于问题的性质。

metricstr or callable, default=’minkowski’

用于距离计算的度量。默认是”minkowski”，当p = 2时，结果为标准的欧几里得距离。请参阅 scipy.spatial.distance 的文档和 distance_metrics 中列出的度量以获取有效的度量值。

如果度量是一个可调用函数，它接受两个表示一维向量的数组作为输入，并返回一个表示这两个向量之间距离的值。这适用于Scipy的度量，但比将度量名称作为字符串传递的效率低。

不支持距离矩阵。

pfloat, default=2

sklearn.metrics.pairwise.pairwise_distances中Minkowski度量的参数。当p = 1时，这相当于使用曼哈顿距离（l1），当p = 2时，相当于使用欧几里得距离（l2）。对于任意p，使用Minkowski距离（l_p）。此参数应为正数。

metric_paramsdict, default=None

度量函数的额外关键字参数。

n_jobsint, default=None

用于邻居搜索的并行作业数。如果为 -1 ，则作业数设置为CPU核心数。

Attributes:

effective_metric_str or callable: 使用的距离度量。它将与 metric 参数相同或为其同义词，例如，如果 metric 参数设置为’minkowski’且 p 参数设置为2，则为’euclidean’。
effective_metric_params_dict: 度量函数的额外关键字参数。对于大多数度量，将与 metric_params 参数相同，但如果 effective_metric_ 属性设置为’minkowski’，则可能还包含 p 参数值。
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_samples_fit_int: 拟合数据中的样本数量。

See also

kneighbors_graph: 计算X中点的k-邻居的加权图。
RadiusNeighborsTransformer: 将X转换为半径内邻居的加权图。

Notes

有关将 KNeighborsTransformer 与 TSNE 结合使用的示例，请参阅 TSNE中的近似最近邻。

Examples

>>> from sklearn.datasets import load_wine
>>> from sklearn.neighbors import KNeighborsTransformer
>>> X, _ = load_wine(return_X_y=True)
>>> X.shape
(178, 13)
>>> transformer = KNeighborsTransformer(n_neighbors=5, mode='distance')
>>> X_dist_graph = transformer.fit_transform(X)
>>> X_dist_graph.shape
(178, 178)

fit(X, y=None)#

拟合从训练数据集得到的k近邻变换器。

Parameters:

X{array-like, sparse matrix}，形状为 (n_samples, n_features) 或如果 metric=’precomputed’ 则为 (n_samples, n_samples): 训练数据。
y忽略: 未使用，为了API一致性而存在。

Returns:

selfKNeighborsTransformer: 拟合的k近邻变换器。

fit_transform(X, y=None)#

拟合数据，然后进行转换。

将转换器拟合到X和y，可选参数为fit_params，并返回X的转换版本。

Parameters:

X形状为(n_samples, n_features)的类数组: 训练集。
y忽略: 未使用，为保持API一致性而存在。

Returns:

Xt形状为(n_samples, n_samples)的稀疏矩阵: Xt[i, j] 被分配连接i到j的边的权重。只有邻居有显式值。对角线始终是显式的。矩阵为CSR格式。

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: 参数名称映射到它们的值。

kneighbors(X=None, n_neighbors=None, return_distance=True)#

查找一个点的K近邻。

返回每个点的邻居的索引和距离。

Parameters:

X{array-like, sparse matrix}, shape (n_queries, n_features), 或 (n_queries, n_indexed) 如果 metric == ‘precomputed’, default=None: 查询点或点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不视为其自身的邻居。
n_neighborsint, default=None: 每个样本所需的邻居数量。默认值是在构造函数中传递的值。
return_distancebool, default=True: 是否返回距离。

Returns:

neigh_distndarray of shape (n_queries, n_neighbors): 表示到点的长度的数组，仅在 return_distance=True 时存在。
neigh_indndarray of shape (n_queries, n_neighbors): 在总体矩阵中最接近点的索引。

Examples

在以下示例中，我们从一个表示数据集的数组构造一个 NearestNeighbors 类，并询问谁是 [1,1,1] 最近的点

>>> samples = [[0., 0., 0.], [0., .5, 0.], [1., 1., .5]]
>>> from sklearn.neighbors import NearestNeighbors
>>> neigh = NearestNeighbors(n_neighbors=1)
>>> neigh.fit(samples)
NearestNeighbors(n_neighbors=1)
>>> print(neigh.kneighbors([[1., 1., 1.]]))
(array([[0.5]]), array([[2]]))

如你所见，它返回 [[0.5]] 和 [[2]]，这意味着元素距离为 0.5，并且是 samples 的第三个元素（索引从 0 开始）。你也可以查询多个点：

>>> X = [[0., 1., 0.], [1., 0., 1.]]
>>> neigh.kneighbors(X, return_distance=False)
array([[1],
       [2]]...)

kneighbors_graph(X=None, n_neighbors=None, mode='connectivity')#

计算X中点的k-邻居的（加权）图。

Parameters:

X{array-like, sparse matrix}，形状为(n_queries, n_features)，或者如果metric == ‘precomputed’，形状为(n_queries, n_indexed)，默认=None: 查询点或点。如果没有提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自身的邻居。对于 metric='precomputed' ，形状应为 (n_queries, n_indexed)。否则，形状应为 (n_queries, n_features)。
n_neighborsint, 默认=None: 每个样本的邻居数量。默认值是在构造函数中传递的值。
mode{‘connectivity’, ‘distance’}, 默认=’connectivity’: 返回矩阵的类型：’connectivity’将返回带有1和0的连通性矩阵，在’distance’中，边是点之间的距离，距离的类型取决于NearestNeighbors类中选择的metric参数。

Returns:

A形状为(n_queries, n_samples_fit)的稀疏矩阵: n_samples_fit 是拟合数据中的样本数量。 A[i, j] 给出连接 i 到 j 的边的权重。矩阵为CSR格式。

Gallery examples#

TSNE中的近似最近邻