K近邻变换器#

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

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

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

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

0.22版本新增。

参数：

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 中列出的度量。

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

不支持距离矩阵。

pfloat, default=2

来自 sklearn.metrics.pairwise.pairwise_distances 的 Minkowski 度量的参数。当 p = 1 时，这等效于使用 manhattan_distance (l1)，而对于 p = 2，则使用 euclidean_distance (l2)。对于任意 p，使用 minkowski_distance (l_p)。此参数应为正值。

metric_paramsdict, default=None

度量函数的其他关键字参数。

n_jobsint, default=None

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

属性：

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: 在拟合期间看到的特征数。

0.24版本新增。
feature_names_in_ndarray of shape (n_features_in_,): 在拟合期间看到的特征名称。仅当 X 具有全是字符串的特征名称时才定义。

1.0版本新增。
n_samples_fit_int: 拟合数据中的样本数。

另请参阅

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

备注

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

示例

>>> 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)[source]#

从训练数据集拟合k-最近邻转换器。

参数：

X{array-like, sparse matrix} of shape (n_samples, n_features) or (n_samples, n_samples) if metric=’precomputed’: 训练数据。
y忽略: 未使用，出于 API 一致性约定而存在。

返回：

selfKNeighborsTransformer: 拟合的k-最近邻转换器。

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

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

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

参数：

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

返回：

Xt形状为(n_samples, n_samples)的稀疏矩阵: Xt[i, j]赋值为连接i和j的边的权重。只有邻居具有显式值。对角线总是显式的。矩阵为CSR格式。

get_feature_names_out(input_features=None)[source]#

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

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

参数：

input_featuresstr类型的类数组或None，默认为None: 仅用于使用在fit中看到的名称验证特征名称。

返回：

feature_names_outstr对象的ndarray: 转换后的特征名称。

get_metadata_routing()[source]#

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

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

返回：

routingMetadataRequest: 一个MetadataRequest 封装路由信息。

get_params(deep=True)[source]#

获取此估计器的参数。

参数：

deep布尔值，默认为True: 如果为True，则将返回此估计器和包含的子对象（这些子对象是估计器）的参数。

返回：

params字典: 参数名称与其值的映射。

kneighbors(X=None, n_neighbors=None, return_distance=True)[source]#

查找一个点的K近邻。

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

参数：

X形状为(n_queries, n_features)的{类数组，稀疏矩阵}，如果metric == ‘precomputed’，则为(n_queries, n_indexed)，默认为None: 查询点或多个点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被认为是它自己的邻居。
n_neighbors整数，默认为None: 每个样本所需的邻居数。默认为传递给构造函数的值。
return_distance布尔值，默认为True: 是否返回距离。

返回：

neigh_dist形状为(n_queries, n_neighbors)的ndarray: 表示到点的长度的数组，仅当return_distance=True时才存在。
neigh_ind形状为(n_queries, n_neighbors)的ndarray: 总体矩阵中最接近点的索引。

示例

在下面的示例中，我们从一个表示数据集的数组构造一个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，并且是样本的第三个元素（索引从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')[source]#

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

参数：

X形状为(n_queries, n_features)的{类数组，稀疏矩阵}，如果metric == ‘precomputed’，则为(n_queries, n_indexed)，默认为None: 查询点或多个点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被认为是它自己的邻居。对于metric='precomputed'，形状应为(n_queries, n_indexed)。否则，形状应为(n_queries, n_features)。
n_neighbors整数，默认为None: 每个样本的邻居数。默认为传递给构造函数的值。
mode{'connectivity', 'distance'}，默认为'connectivity': 返回矩阵的类型：'connectivity'将返回具有1和0的连通性矩阵，在'distance'中，边是点之间的距离，距离的类型取决于NearestNeighbors类中选择的metric参数。

返回：

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

另请参阅

NearestNeighbors.radius_neighbors_graph: 计算 X 中点的（加权）邻域图。

示例

>>> X = [[0], [3], [1]]
>>> from sklearn.neighbors import NearestNeighbors
>>> neigh = NearestNeighbors(n_neighbors=2)
>>> neigh.fit(X)
NearestNeighbors(n_neighbors=2)
>>> A = neigh.kneighbors_graph(X)
>>> A.toarray()
array([[1., 0., 1.],
       [0., 1., 1.],
       [1., 0., 1.]])