NearestNeighbors

classsklearn.neighbors.NearestNeighbors(*, n_neighbors=5, radius=1.0, algorithm='auto', leaf_size=30, metric='minkowski', p=2, metric_params=None, n_jobs=None)[исходный код]

Обучение без учителя для реализации поиска соседей.

Подробнее см. в руководстве пользователя.

Добавлено в версии 0.9.

Параметры:

n_neighborsint, по умолчанию=5

Число соседей, используемое по умолчанию для запросов kneighbors.

radiusfloat, по умолчанию=1.0

Диапазон пространства параметров, используемый по умолчанию для запросов radius_neighbors.

algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, по умолчанию=’auto’

Алгоритм, используемый для вычисления ближайших соседей:

• ‘ball_tree’ использует BallTree
• ‘kd_tree’ использует KDTree
• ‘brute’ использует полный перебор.
• ‘auto’ попытается выбрать наиболее подходящий алгоритм на основе значений, переданных методу fit.

Примечание: при обучении на разреженных входных данных значение этого параметра будет переопределено, и будет использоваться полный перебор.

leaf_sizeint, по умолчанию=30

Размер листа, передаваемый в BallTree или KDTree. Он может влиять на скорость построения и выполнения запросов, а также на объем памяти, необходимый для хранения дерева. Оптимальное значение зависит от особенностей задачи.

metricstr или вызываемый объект, по умолчанию=’minkowski’

Метрика для вычисления расстояния. По умолчанию используется «minkowski», которая при p = 2 соответствует стандартному евклидову расстоянию. Допустимые значения метрик см. в документации scipy.spatial.distance и в списке метрик distance_metrics.

Если metric имеет значение “precomputed”, предполагается, что X является матрицей расстояний; во время обучения она должна быть квадратной. X может быть разреженным графом; в этом случае соседями могут считаться только элементы, отличные от нуля.

Если metric — вызываемая функция, она принимает на вход два массива, представляющих одномерные векторы, и должна возвращать одно значение, указывающее расстояние между этими векторами. Это работает с метриками SciPy, но менее эффективно, чем передача названия метрики в виде строки.

pfloat (положительное), по умолчанию=2

Параметр метрики Минковского из sklearn.metrics.pairwise.pairwise_distances. При p = 1 она эквивалентна manhattan_distance (l1), а при p = 2 — euclidean_distance (l2). Для произвольного p используется minkowski_distance (l_p).

metric_paramsdict, по умолчанию=None

Дополнительные именованные аргументы для функции метрики.

n_jobsint, по умолчанию=None

Число параллельных заданий для поиска соседей. None означает 1, если только не используется контекст joblib.parallel_backend. -1 означает использование всех процессоров. Подробнее см. в глоссарии.

Атрибуты:

effective_metric_str

Метрика, используемая для вычисления расстояний до соседей.

effective_metric_params_dict

Параметры метрики, используемой для вычисления расстояний до соседей.

n_features_in_int

Число признаков, обнаруженных во время обучения.

Добавлено в версии 0.24.

feature_names_in_ndarray формы (n_features_in_,)

Названия признаков, обнаруженных во время обучения. Определяется только в том случае, если X содержит названия признаков, представленные строками.

Добавлено в версии 1.0.

n_samples_fit_int

Число образцов в обучающих данных.

См. также

KNeighborsClassifier

Классификатор, реализующий голосование k ближайших соседей.

RadiusNeighborsClassifier

Классификатор, реализующий голосование среди соседей в заданном радиусе.

KNeighborsRegressor

Регрессия на основе k ближайших соседей.

RadiusNeighborsRegressor

Регрессия на основе соседей в фиксированном радиусе.

BallTree

Структура данных для разбиения пространства и организации точек в многомерном пространстве, используемая для поиска ближайших соседей.

Примечания

Обсуждение выбора algorithm и leaf_size см. в разделе «Ближайшие соседи» онлайн-документации.

https://en.wikipedia.org/wiki/K-nearest_neighbors_algorithm

Примеры

>>> import numpy as np
>>> from sklearn.neighbors import NearestNeighbors
>>> samples = [[0, 0, 2], [1, 0, 0], [0, 0, 1]]
>>> neigh = NearestNeighbors(n_neighbors=2, radius=0.4)
>>> neigh.fit(samples)
NearestNeighbors(...)
>>> neigh.kneighbors([[0, 0, 1.3]], 2, return_distance=False)
array([[2, 0]]...)
>>> nbrs = neigh.radius_neighbors(
...    [[0, 0, 1.3]], 0.4, return_distance=False
... )
>>> np.asarray(nbrs[0][0])
array(2)

fit(X, y=None)[исходный код]

Обучить оцениватель ближайших соседей на обучающем наборе данных.

Параметры:

X{array-like, sparse matrix} формы (n_samples, n_features) или (n_samples, n_samples), если metric=’precomputed’

Обучающие данные.

yИгнорируется

Не используется; присутствует для согласованности API в соответствии с соглашением.

Возвращает:

selfNearestNeighbors

Обученный оцениватель ближайших соседей.

get_metadata_routing()[исходный код]

Получить маршрутизацию метаданных этого объекта.

О том, как работает механизм маршрутизации, см. в руководстве пользователя.

Возвращает:

routingMetadataRequest

Объект MetadataRequest, содержащий сведения о маршрутизации.

get_params(deep=True)[исходный код]

Получить параметры этого оценивателя.

Параметры:

deepbool, по умолчанию=True

Если значение True, будут возвращены параметры этого оценивателя и содержащихся в нем подобъектов, которые являются оценивателями.

Возвращает:

paramsdict

Названия параметров, сопоставленные их значениям.

kneighbors(X=None, n_neighbors=None, return_distance=True)[исходный код]

Найти K ближайших соседей точки.

Возвращает индексы соседей каждой точки и расстояния до них.

Параметры:

X{array-like, sparse matrix}, форма (n_queries, n_features) или (n_queries, n_indexed), если metric == ‘precomputed’, по умолчанию=None

Точка или точки запроса. Если не указаны, возвращаются соседи каждой индексированной точки. В этом случае точка запроса не считается своим собственным соседом.

n_neighborsint, по умолчанию=None

Число соседей для каждого образца. По умолчанию используется значение, переданное конструктору.

return_distancebool, по умолчанию=True

Возвращать ли расстояния.

Возвращает:

neigh_distndarray формы (n_queries, n_neighbors)

Массив расстояний до точек; присутствует только при return_distance=True.

neigh_indndarray формы (n_queries, n_neighbors)

Индексы ближайших точек в матрице набора данных.

Примеры

В следующем примере мы создаем класс 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')[исходный код]

Вычислить (взвешенный) граф k ближайших соседей для точек в X.

Параметры:

X{array-like, sparse matrix} формы (n_queries, n_features) или (n_queries, n_indexed), если metric == ‘precomputed’, по умолчанию=None

Точка или точки запроса. Если не указаны, возвращаются соседи каждой индексированной точки. В этом случае точка запроса не считается своим собственным соседом. Для metric='precomputed' форма должна быть (n_queries, n_indexed). В противном случае форма должна быть (n_queries, n_features).

n_neighborsint, по умолчанию=None

Число соседей для каждого образца. По умолчанию используется значение, переданное конструктору.

mode{‘connectivity’, ‘distance’}, по умолчанию=’connectivity’

Тип возвращаемой матрицы: ‘connectivity’ возвращает матрицу связности с единицами и нулями; в режиме ‘distance’ ребра представляют собой расстояния между точками, тип расстояния зависит от параметра метрики, выбранного в классе NearestNeighbors.

Возвращает:

Asparse-matrix формы (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.]])

radius_neighbors(X=None, radius=None, return_distance=True, sort_results=False)[исходный код]

Найти соседей одной или нескольких точек в заданном радиусе.

Возвращает индексы и расстояния до точек из набора данных, лежащих в шаре радиуса radius вокруг точек массива запроса. Точки на границе включаются в результаты.

Возвращаемые точки не обязательно отсортированы по расстоянию до точки запроса.

Параметры:

X{array-like, sparse matrix} формы (n_samples, n_features), по умолчанию=None

Точка или точки запроса. Если не указаны, возвращаются соседи каждой индексированной точки. В этом случае точка запроса не считается своим собственным соседом.

radiusfloat, по умолчанию=None

Предельное расстояние до возвращаемых соседей. По умолчанию используется значение, переданное конструктору.

return_distancebool, по умолчанию=True

Возвращать ли расстояния.

sort_resultsbool, по умолчанию=False

Если значение True, перед возвратом расстояния и индексы сортируются по возрастанию расстояния. Если значение False, результаты могут быть не отсортированы. Если return_distance=False, установка sort_results=True приведет к ошибке.

Добавлено в версии 0.22.

Возвращает:

neigh_distndarray формы (n_samples,), содержащий массивы

Массив расстояний до каждой точки; присутствует только при return_distance=True. Значения расстояний вычисляются в соответствии с параметром конструктора metric.

neigh_indndarray формы (n_samples,), содержащий массивы

Массив массивов с индексами приблизительно ближайших точек из матрицы набора данных, лежащих в шаре радиуса radius вокруг точек запроса.

Примечания

Поскольку число соседей каждой точки может различаться, результаты для нескольких точек запроса нельзя разместить в стандартном массиве данных. Для повышения эффективности radius_neighbors возвращает массивы объектов, каждый из которых представляет собой одномерный массив индексов или расстояний.

Примеры

В следующем примере мы создаем класс NeighborsClassifier на основе массива, представляющего наш набор данных, и спрашиваем, какая точка ближе всего к [1, 1, 1]:

>>> import numpy as np
>>> samples = [[0., 0., 0.], [0., .5, 0.], [1., 1., .5]]
>>> from sklearn.neighbors import NearestNeighbors
>>> neigh = NearestNeighbors(radius=1.6)
>>> neigh.fit(samples)
NearestNeighbors(radius=1.6)
>>> rng = neigh.radius_neighbors([[1., 1., 1.]])
>>> print(np.asarray(rng[0][0]))
[1.5 0.5]
>>> print(np.asarray(rng[1][0]))
[1 2]

Первый возвращенный массив содержит расстояния до всех точек, находящихся ближе чем на 1.6, а второй возвращенный массив содержит их индексы. Как правило, запрос можно одновременно отправить для нескольких точек.

radius_neighbors_graph(X=None, radius=None, mode='connectivity', sort_results=False)[исходный код]

Вычислить (взвешенный) граф соседей для точек в X.

В окрестности включаются только точки, расстояние до которых меньше радиуса.

Параметры:

X{array-like, sparse matrix} формы (n_samples, n_features), по умолчанию=None

Точка или точки запроса. Если не указаны, возвращаются соседи каждой индексированной точки. В этом случае точка запроса не считается своим собственным соседом.

radiusfloat, по умолчанию=None

Радиус окрестностей. По умолчанию используется значение, переданное конструктору.

mode{‘connectivity’, ‘distance’}, по умолчанию=’connectivity’

Тип возвращаемой матрицы: ‘connectivity’ возвращает матрицу связности с единицами и нулями; в режиме ‘distance’ ребра представляют собой расстояния между точками, тип расстояния зависит от параметра метрики, выбранного в классе NearestNeighbors.

sort_resultsbool, по умолчанию=False

Если значение True, ненулевые элементы каждой строки результата сортируются по возрастанию расстояния. Если значение False, ненулевые элементы могут быть не отсортированы. Используется только при mode=’distance’.

Добавлено в версии 0.22.

Возвращает:

Asparse-matrix формы (n_queries, n_samples_fit)

n_samples_fit — число образцов в обучающих данных. A[i, j] задает вес ребра, соединяющего i с j. Матрица имеет формат CSR.

См. также

kneighbors_graph

Вычислить (взвешенный) граф k ближайших соседей для точек в X.

Примеры

>>> X = [[0], [3], [1]]
>>> from sklearn.neighbors import NearestNeighbors
>>> neigh = NearestNeighbors(radius=1.5)
>>> neigh.fit(X)
NearestNeighbors(radius=1.5)
>>> A = neigh.radius_neighbors_graph(X)
>>> A.toarray()
array([[1., 0., 1.],
       [0., 1., 0.],
       [1., 0., 1.]])

set_params(**params)[исходный код]

Задать параметры этого оценивателя.

Метод работает как с простыми оценивателями, так и с вложенными объектами (например, Pipeline). Параметры последних имеют формат <component>__<parameter>, что позволяет обновлять каждый компонент вложенного объекта.

Параметры:

**paramsdict

Параметры оценивателя.

Возвращает:

selfэкземпляр оценивателя

Экземпляр оценивателя.

Примеры из галереи

Приближенный поиск ближайших соседей в TSNE