KNeighborsTransformer

classsklearn.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’ возвращает матрицу связности с единицами и нулями, а значение ‘distance’ — расстояния между соседями согласно заданной метрике.

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

Количество соседей для каждого образца в преобразованном разреженном графе. Для обеспечения совместимости каждый образец считается своим собственным соседом, поэтому при mode == ‘distance’ вычисляется один дополнительный сосед. В этом случае разреженный граф содержит (n_neighbors + 1) соседей.

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 — вызываемая функция, она принимает на вход два массива, представляющих одномерные векторы, и должна возвращать одно значение, обозначающее расстояние между этими векторами. Это работает с метриками 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

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

Атрибуты:

effective_metric_str или вызываемый объект

Используемая метрика расстояния. Она совпадает с параметром metric или является его синонимом, например ‘euclidean’, если параметр metric задан как ‘minkowski’, а параметр p — как 2.

effective_metric_params_dict

Дополнительные именованные аргументы для функции метрики. Для большинства метрик они совпадают с параметром metric_params, но также могут содержать значение параметра p, если атрибут effective_metric_ задан как ‘minkowski’.

n_features_in_int

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

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

feature_names_in_ndarray формы (n_features_in_,)

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

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

n_samples_fit_int

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

См. также

kneighbors_graph

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

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{array-like, sparse matrix} формы (n_samples, n_features) или (n_samples, n_samples), если metric=’precomputed’

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

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

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

Возвращает:

selfKNeighborsTransformer

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

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

Обучает преобразователь на данных, а затем преобразует их.

Обучает преобразователь на X и y с необязательными параметрами fit_params и возвращает преобразованную версию 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)[исходный код]

Возвращает названия признаков на выходе преобразования.

К названиям выходных признаков добавляется имя класса в нижнем регистре. Например, если преобразователь возвращает 3 признака, их названия будут такими: ["class_name0", "class_name1", "class_name2"].

Параметры:

input_featuresarray-like строк или None, по умолчанию=None

Используется только для проверки названий признаков по названиям, обнаруженным в fit.

Возвращает:

feature_names_outndarray объектов str

Названия преобразованных признаков.

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’ ребра содержат расстояния между точками; тип расстояния зависит от параметра metric, выбранного для класса 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)[исходный код]

Задает контейнер выходных данных.

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

Параметры:

transform{“default”, “pandas”, “polars”}, по умолчанию=None

Настраивает формат вывода для transform и fit_transform.

• "default": формат вывода преобразователя по умолчанию
• "pandas": вывод в формате DataFrame
• "polars": вывод в формате Polars
• None: конфигурация преобразования остается без изменений

Добавлено в версии 1.4: добавлен параметр "polars".

Возвращает:

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

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

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

Задает параметры этого оценщика.

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

Параметры:

**paramsdict

Параметры оценщика.

Возвращает:

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

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

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

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

Параметры:

Xarray-like формы (n_samples_transform, n_features)

Данные образцов.

Возвращает:

Xtразреженная матрица формы (n_samples_transform, n_samples_fit)

Элементу Xt[i, j] присваивается вес ребра, соединяющего i и j. Явные значения имеют только соседи. Диагональ всегда задана явно. Матрица имеет формат CSR.

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

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

Кэширование ближайших соседей

Основные нововведения scikit-learn 0.22