RadiusNeighborsTransformer

classsklearn.neighbors.RadiusNeighborsTransformer(*, mode='distance', radius=1.0, algorithm='auto', leaf_size=30, metric='minkowski', p=2, metric_params=None, n_jobs=None)[source]

Преобразовать 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 или callable, по умолчанию=’minkowski’

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

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

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

pfloat, по умолчанию=2

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

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

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

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

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)[source]

Произвести подгонку радиус-соседнего трансформатора на обучающих данных.

Параметры:

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

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

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

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

Возвращаемое значение:

selfRadiusNeighborsTransformer

Произведённый подгонку радиус-соседний трансформатор.

fit_transform(X, y=None)[source]

Произвести подгонку к данным, затем преобразовать их.

Подгоняет трансформатор к 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)[source]

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

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

Параметры:

input_featuresarray-like из str или None, по умолчанию=None

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

Возвращаемое значение:

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

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

get_metadata_routing()[source]

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

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

Возвращает:

маршрутизацияMetadataRequest

Объект MetadataRequest encapsulating routing information.

get_params(deep=True)[source]

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

Параметры:

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

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

Возвращает:

paramsdict

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

radius_neighbors(X=None, radius=None, return_distance=True, sort_results=False)[source]

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

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

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

Параметры:

X{array-like, разреженная матрица} размерности (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 возвращает массивы объектов, где каждый объект — это 1D массив индексов или расстояний.

Примеры

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

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

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

Параметры:

X{array-like, разреженная матрица} размерности (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 — число образцов в fitted данных. 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)[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>, чтобы можно было обновить каждый компонент вложенного объекта.

Параметры:

**paramsdict

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

Возвращаемое значение:

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

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

transform(X)[source]

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

Параметры:

Xмассив-подобный объект формы (n_samples_transform, n_features)

Данные выборки.

Возвращаемое значение:

Xtразреженный массив формы (n_samples_transform, n_samples_fit)

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