KNeighborsTransformer

classsklearn.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’ вернёт матрицу связности с единицами и нулями, а ‘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 или callable, default=’minkowski’

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

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

Матрицы расстояний не поддерживаются.

pfloat, default=2

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

metric_paramsdict, default=None

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

n_jobsint, default=None

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

Атрибуты:

effective_metric_str или callable

Используемая метрика расстояния. Она будет такой же, как параметр 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)[source]

Обучение трансформера 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)[source]

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

Обучает трансформер на X и y с необязательными параметрами fit_params и возвращает преобразованную версию X.

Параметры:

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

Обучающий набор.

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

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

Возвращает:

Xtsparse matrix формы (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массив-подобный тип str или None, по умолчанию=None

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

Возвращает:

feature_names_outмассив str объектов

Имена преобразованных признаков.

get_metadata_routing()[source]

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

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

Возвращает:

routingMetadataRequest

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

get_params(deep=True)[source]

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

Параметры:

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

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

Возвращает:

paramsdict

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

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

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

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

Параметры:

X{массив-подобный тип, разреженная матрица}, форма (n_запросов, n_признаков), или (n_запросов, n_индексированных) если метрика == ‘precomputed’, по умолчанию=None

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

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

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

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

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

Возвращает:

neigh_distмассив с формой (n_запросов, n_соседей)

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

neigh_indмассив с формой (n_запросов, n_соседей)

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

Примеры

В следующем примере мы создаём класс 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]

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

Параметры:

X{массив-подобный тип, разреженная матрица} формы (n_запросов, n_признаков), или (n_запросов, n_индексированных) если метрика == ‘precomputed’, по умолчанию=None

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

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

Количество соседей для каждой выборки. По умолчанию — значение, переданное в конструктор.

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

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

Возвращает:

Aразреженная матрица с формой (n_запросов, n_выборка_в_подготовке)

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экземпляр оценщика

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

set_params(**params)[source]

Установите параметры этого оценщика.

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

Parameters:

**paramsdict

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

Returns:

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

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

transform(X)[source]

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

Parameters:

Xarray-like of shape (n_samples_transform, n_features)

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

Returns:

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

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

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

Основные моменты выпуска scikit-learn 0.22

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

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