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)[source]#
将 X 转换为 k 近邻的（加权）图。
转换后的数据是 `kneighbors_graph` 返回的稀疏图。
更多信息请参阅用户指南。
在 0.22 版本中新增。
- 参数：
- mode{‘distance’, ‘connectivity’}，默认值 'distance'
返回矩阵的类型：'connectivity' 将返回由 0 和 1 组成的连接矩阵，而 'distance' 将根据给定度量返回邻居之间的距离。
- n_neighborsint 型，默认值 5
转换后的稀疏图中每个样本的邻居数量。出于兼容性考虑，由于每个样本都被视为其自身的邻居，因此当 `mode == 'distance'` 时，会计算一个额外的邻居。在这种情况下，稀疏图包含 `(n_neighbors + 1)` 个邻居。
- algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}，默认值 'auto'
用于计算最近邻的算法
注意：在稀疏输入上拟合将覆盖此参数的设置，使用暴力方法。
- leaf_sizeint 型，默认值 30
传递给 `BallTree` 或 `KDTree` 的叶子大小。这会影响构建和查询的速度，以及存储树所需的内存。最佳值取决于问题的性质。
- metric字符串或可调用对象，默认值 'minkowski'
用于距离计算的度量。默认值为“minkowski”，当 p = 2 时，它会产生标准的欧几里得距离。有关有效度量值，请参阅 scipy.spatial.distance 的文档以及
distance_metrics中列出的度量。如果 `metric` 是一个可调用函数，它将两个表示一维向量的数组作为输入，并且必须返回一个指示这些向量之间距离的值。这适用于 Scipy 的度量，但效率低于将度量名称作为字符串传递。
不支持距离矩阵。
- p浮点型，默认值 2
来自 `sklearn.metrics.pairwise.pairwise_distances` 的 Minkowski 度量的参数。当 `p = 1` 时，这等效于使用 `manhattan_distance (l1)`；当 `p = 2` 时，等效于 `euclidean_distance (l2)`。对于任意 `p`，使用 `minkowski_distance (l_p)`。此参数应为正值。
- metric_params字典，默认值 None
度量函数的额外关键字参数。
- n_jobsint 型，默认值 None
用于邻居搜索的并行作业数量。如果为
-1，则作业数量设置为 CPU 核心数。
- 属性：
- effective_metric_字符串或可调用对象
使用的距离度量。它将与
metric参数相同或其同义词，例如，如果metric参数设置为 'minkowski' 且p参数设置为 2，则为 'euclidean'。- effective_metric_params_字典
度量函数的额外关键字参数。对于大多数度量，将与
metric_params参数相同，但如果effective_metric_属性设置为 'minkowski'，也可能包含p参数值。- n_features_in_int 型
在 拟合 期间看到的特征数量。
在 0.24 版本中新增。
- feature_names_in_形状为 (
n_features_in_,) 的 ndarray 在 拟合 期间看到的特征名称。仅当
X的所有特征名称均为字符串时才定义。在 1.0 版本中新增。
- n_samples_fit_int 型
拟合数据中的样本数量。
另请参阅
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}，形状为 (n_samples, n_features)；如果 metric='precomputed'，则为 (n_samples, n_samples)
训练数据。
- y忽略
未使用，依约定为保持 API 一致性而存在。
- 返回：
- selfKNeighborsTransformer 实例
拟合后的 k-最近邻转换器。
- fit_transform(X, y=None)[source]#
拟合数据，然后进行转换。
使用可选参数 `fit_params` 将转换器拟合到 X 和 y，并返回 X 的转换版本。
- 参数：
- Xarray-like，形状为 (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_features字符串类型的 array-like 或 None，默认值 None
仅用于根据
fit中看到的名称验证特征名称。
- 返回：
- feature_names_out字符串对象类型的 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{array-like, sparse matrix}，形状为 (n_queries, n_features)；如果 metric == ‘precomputed’，则为 (n_queries, n_indexed)；默认值 None
查询点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自身的邻居。
- n_neighborsint 型，默认值 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{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' 将返回由 0 和 1 组成的连接矩阵，在 'distance' 中，边是点之间的距离，距离类型取决于 `NearestNeighbors` 类中选定的度量参数。
- 返回：
- 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.]])
- set_output(*, transform=None)[source]#
设置输出容器。
有关如何使用此 API 的示例，请参阅 介绍 set_output API。
- 参数：
- transform{“default”, “pandas”, “polars”}，默认值 None
配置
transform和fit_transform的输出。“default”：转换器的默认输出格式
“pandas”：DataFrame 输出
“polars”：Polars 输出
None：转换配置未更改
在 1.4 版本中新增：添加了
"polars"选项。
- 返回：
- self估计器实例
估计器实例。
