RadiusNeighborsTransformer

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

Преобразует X в (взвешенный) граф соседей, расположенных на расстоянии меньше заданного радиуса.

Преобразованные данные представляют собой разреженный граф, возвращаемый radius_neighbors_graph.

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

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

Параметры:

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

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

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

Радиус окрестности в преобразованном разреженном графе.

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

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

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

feature_names_in_ndarray формы (n_features_in_,)

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

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

n_samples_fit_int

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

См. также

kneighbors_graph

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

KNeighborsTransformer

Преобразует X во взвешенный граф k ближайших соседей.

Примеры

>>> import numpy as np
>>> from sklearn.datasets import load_wine
>>> from sklearn.cluster import DBSCAN
>>> from sklearn.neighbors import RadiusNeighborsTransformer
>>> from sklearn.pipeline import make_pipeline
>>> X, _ = load_wine(return_X_y=True)
>>> estimator = make_pipeline(
...     RadiusNeighborsTransformer(radius=42.0, mode='distance'),
...     DBSCAN(eps=25.0, metric='precomputed'))
>>> X_clustered = estimator.fit_predict(X)
>>> clusters, counts = np.unique(X_clustered, return_counts=True)
>>> print(counts)
[ 29  15 111  11  12]

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

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

Параметры:

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

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

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

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

Возвращает:

selfRadiusNeighborsTransformer

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

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 из str или None, по умолчанию=None

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

Возвращает:

feature_names_outndarray из объектов str

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

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

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

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

Возвращает:

routingMetadataRequest

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

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

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

Параметры:

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

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

Возвращает:

paramsdict

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

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.

Окрестности ограничены точками, находящимися на расстоянии меньше radius.

Параметры:

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.

Возвращает:

Aразреженная матрица формы (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_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.