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 返回的稀疏圖。

在使用者指南中閱讀更多內容。

0.22 版本新增。

參數:

mode{‘distance’, ‘connectivity’}, 預設為 ‘distance’

返回矩陣的類型：'connectivity' 將返回由 1 和 0 組成的連接矩陣，而 'distance' 將根據給定的度量返回鄰居之間的距離。

n_neighbors整數，預設為 5

轉換後的稀疏圖中每個樣本的鄰居數。為了相容性，由於每個樣本都被視為自己的鄰居，當 mode == ‘distance’ 時，將會計算一個額外的鄰居。在這種情況下，稀疏圖包含 (n_neighbors + 1) 個鄰居。

algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, 預設為 ‘auto’

用於計算最近鄰居的演算法

‘ball_tree’ 將使用 BallTree
‘kd_tree’ 將使用 KDTree
‘brute’ 將使用暴力搜尋。
‘auto’ 將嘗試根據傳遞給 fit 方法的值來決定最合適的演算法。

注意：擬合稀疏輸入將覆蓋此參數的設定，並使用暴力搜尋。

leaf_size整數，預設為 30

傳遞給 BallTree 或 KDTree 的葉子大小。這會影響建構和查詢的速度，以及儲存樹所需的記憶體。最佳值取決於問題的性質。

metric字串或可呼叫物件，預設為 ‘minkowski’

用於距離計算的度量。預設值為 “minkowski”，當 p = 2 時，會產生標準的歐幾里得距離。請參閱 scipy.spatial.distance 的文件，以及 distance_metrics 中列出的度量，以取得有效的度量值。

如果度量是可呼叫的函數，它會接收兩個代表 1 維向量的陣列作為輸入，並且必須傳回一個指示這些向量之間距離的值。這適用於 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_jobs整數，預設為 None

用於鄰居搜尋的平行作業數。如果為 -1，則作業數會設定為 CPU 核心數。

屬性:

effective_metric_字串或可呼叫物件: 使用的距離度量。它會與 metric 參數相同，或是它的同義詞，例如，如果 metric 參數設定為 'minkowski'，而 p 參數設定為 2，則為 ‘euclidean’。
effective_metric_params_字典: 度量函數的其他關鍵字引數。對於大多數度量，會與 metric_params 參數相同，但也可能包含 p 參數值，如果 effective_metric_ 屬性設定為 'minkowski'。
n_features_in_整數: 在 fit 期間看到的特徵數量。

0.24 版本新增。
feature_names_in_形狀為 (n_features_in_,) 的 ndarray: 在 fit 期間看到的特徵名稱。僅當 X 具有全部為字串的特徵名稱時才定義。

1.0 版本新增。
n_samples_fit_整數: 擬合資料中的樣本數。

另請參閱

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)[原始碼]#

從訓練資料集擬合 k 最近鄰居轉換器。

參數:

X{類陣列, 稀疏矩陣}，形狀為 (n_samples, n_features) 或 (n_samples, n_samples)，如果 metric='precomputed': 訓練資料。
y已忽略: 未使用，為了 API 的一致性而依照慣例存在。

返回:

selfKNeighborsTransformer: 擬合的 k 最近鄰居轉換器。

fit_transform(X, y=None)[原始碼]#

擬合資料，然後轉換它。

使用選用的參數 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)[原始碼]#

取得轉換後的輸出特徵名稱。

輸出特徵名稱將會以小寫的類別名稱作為前綴。舉例來說，如果轉換器輸出 3 個特徵，則輸出特徵名稱為：["class_name0", "class_name1", "class_name2"]。

參數:

input_features類陣列 (array-like) 的字串或 None，預設為 None: 僅用於驗證特徵名稱是否與 fit 中看到的名稱一致。

返回:

feature_names_out字串物件的 ndarray: 轉換後的特徵名稱。

get_metadata_routing()[原始碼]#

取得此物件的中繼資料路由。

請查看使用者指南，了解路由機制如何運作。

返回:

routingMetadataRequest: 一個封裝路由資訊的 MetadataRequest。

get_params(deep=True)[原始碼]#

取得此估計器的參數。

參數:

deep布林值，預設為 True: 如果為 True，將會回傳此估計器及其包含的子物件（也是估計器）的參數。

返回:

params字典 (dict): 參數名稱對應到其值的字典。

kneighbors(X=None, n_neighbors=None, return_distance=True)[原始碼]#

尋找一個點的 K 個鄰居。

回傳每個點的鄰居的索引和距離。

參數:

X{類陣列, 稀疏矩陣}, 形狀為 (n_queries, n_features), 或 (n_queries, n_indexed) 如果 metric == 'precomputed'，預設為 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')[原始碼]#

計算 X 中點的 k-鄰居（加權）圖。

參數:

X形狀為 (n_queries, n_features) 的 {類陣列, 稀疏矩陣}，或 (n_queries, n_indexed) 如果 metric == 'precomputed'，預設為 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.]])