RadiusNeighborsClassifier

classsklearn.neighbors.RadiusNeighborsClassifier(radius=1.0, *, weights='uniform', algorithm='auto', leaf_size=30, p=2, metric='minkowski', outlier_label=None, metric_params=None, n_jobs=None)[источник]

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

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

Параметры:

radiusfloat, default=1.0

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

weights{‘uniform’, ‘distance’}, callable or None, default=’uniform’

Функция весов, используемая при предсказании. Возможные значения:

• ‘uniform’ : одинаковые веса. Все точки в каждом окрестностном множестве имеют одинаковый вес.
• ‘distance’ : вес точек обратно пропорционален расстоянию до них. В этом случае близкие соседи точки запроса будут влиять сильнее, чем более удалённые соседи.
• [callable] : пользовательская функция, принимающая массив расстояний и возвращающая массив той же формы, содержащий веса.

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

algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, default=’auto’

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

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

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

leaf_sizeint, default=30

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

pfloat, default=2

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

metricstr or callable, default=’minkowski’

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

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

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

outlier_label{manual label, ‘most_frequent’}, default=None

Метка для выбросов (образцов, у которых нет соседей в заданном радиусе).

• ручная метка: метка типа str или int (должна иметь тот же тип, что и y) либо список ручных меток при использовании нескольких выходов.
• ‘most_frequent’ : выбросам присваивается наиболее часто встречающаяся метка в y.
• None : при обнаружении любого выброса будет вызвана ошибка ValueError.

Метка выброса должна выбираться из уникальных меток ‘Y’. Если указать другое значение, будет выдано предупреждение, а все вероятности классов для выбросов будут равны 0.

metric_paramsdict, default=None

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

n_jobsint, default=None

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

Атрибуты:

classes_ndarray of shape (n_classes,)

Метки классов, известные классификатору.

effective_metric_str or 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 of shape (n_features_in_,)

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

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

n_samples_fit_int

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

outlier_label_int or array-like of shape (n_class,)

Метка, присваиваемая выбросам (образцам, у которых нет соседей в заданном радиусе).

outputs_2d_bool

Значение False, если во время обучения форма y равна (n_samples, ) или (n_samples, 1); в противном случае — True.

См. также

KNeighborsClassifier

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

RadiusNeighborsRegressor

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

KNeighborsRegressor

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

NearestNeighbors

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

Примечания

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

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

Примеры

>>> X = [[0], [1], [2], [3]]
>>> y = [0, 0, 1, 1]
>>> from sklearn.neighbors import RadiusNeighborsClassifier
>>> neigh = RadiusNeighborsClassifier(radius=1.0)
>>> neigh.fit(X, y)
RadiusNeighborsClassifier(...)
>>> print(neigh.predict([[1.5]]))
[0]
>>> print(neigh.predict_proba([[1.0]]))
[[0.66666667 0.33333333]]

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

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

Параметры:

X{array-like, sparse matrix} of shape (n_samples, n_features) or (n_samples, n_samples) if metric=’precomputed’

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

y{array-like, sparse matrix} of shape (n_samples,) or (n_samples, n_outputs)

Целевые значения.

Возвращает:

selfRadiusNeighborsClassifier

Обученный классификатор соседей в радиусе.

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

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

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

Возвращает:

routingMetadataRequest

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

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

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

Параметры:

deepbool, default=True

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

Возвращает:

paramsdict

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

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

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

Параметры:

X{array-like, sparse matrix} of shape (n_queries, n_features), or (n_queries, n_indexed) if metric == ‘precomputed’, or None

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

Возвращает:

yndarray of shape (n_queries,) or (n_queries, n_outputs)

Метки классов для каждого образца данных.

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

Вернуть оценки вероятностей для тестовых данных X.

Параметры:

X{array-like, sparse matrix} of shape (n_queries, n_features), or (n_queries, n_indexed) if metric == ‘precomputed’, or None

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

Возвращает:

pndarray of shape (n_queries, n_classes), or a list of n_outputs of such arrays if n_outputs > 1.

Вероятности классов для входных образцов. Классы упорядочены лексикографически.

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

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

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

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

Параметры:

X{array-like, sparse matrix} of (n_samples, n_features), default=None

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

radiusfloat, default=None

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

return_distancebool, default=True

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

sort_resultsbool, default=False

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

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

Возвращает:

neigh_distndarray of shape (n_samples,) of arrays

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

neigh_indndarray of shape (n_samples,) of arrays

Массив массивов индексов приблизительных ближайших точек из матрицы объектов, находящихся в шаре радиуса 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} of shape (n_samples, n_features), default=None

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

radiusfloat, default=None

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

mode{‘connectivity’, ‘distance’}, default=’connectivity’

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

sort_resultsbool, default=False

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

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

Возвращает:

Asparse-matrix of shape (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.]])

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

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

В задаче многометочной классификации это точность по подмножествам — строгая метрика, поскольку для каждого образца требуется правильно предсказать полный набор меток.

Параметры:

Xarray-like of shape (n_samples, n_features), or None

Тестовые образцы. Если None, используются предсказания для всех индексированных точек; в этом случае точки не считаются собственными соседями. Это означает, что knn.fit(X, y).score(None, y) неявно выполняет перекрёстную проверку с исключением одного наблюдения и эквивалентен cross_val_score(knn, X, y, cv=LeaveOneOut()), но обычно работает намного быстрее.

yarray-like of shape (n_samples,) or (n_samples, n_outputs)

Истинные метки для X.

sample_weightarray-like of shape (n_samples,), default=None

Веса образцов.

Возвращает:

scorefloat

Средняя точность self.predict(X) относительно y.

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

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

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

Параметры:

**paramsdict

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

Возвращает:

selfestimator instance

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

set_score_request(*, sample_weight:bool|None|str='$UNCHANGED$') → RadiusNeighborsClassifier[исходный код]

Настроить, следует ли запрашивать передачу метаданных методу score.

Обратите внимание, что этот метод имеет значение только тогда, когда данный оценщик используется как подоценщик внутри метаоценщика и включена маршрутизация метаданных с помощью enable_metadata_routing=True (см. sklearn.set_config). О том, как работает механизм маршрутизации, см. в Руководстве пользователя.

Для каждого параметра доступны следующие варианты:

• True: метаданные запрашиваются и передаются в score, если они предоставлены. Запрос игнорируется, если метаданные не предоставлены.
• False: метаданные не запрашиваются, и метаоценщик не передаёт их в score.
• None: метаданные не запрашиваются, и метаоценщик вызовет ошибку, если пользователь их предоставит.
• str: метаданные следует передать метаоценщику под указанным псевдонимом вместо исходного имени.

Значение по умолчанию (sklearn.utils.metadata_routing.UNCHANGED) сохраняет существующий запрос. Это позволяет изменить запрос для одних параметров, не изменяя его для остальных.

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

Параметры:

sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Маршрутизация метаданных для параметра sample_weight в score.

Возвращает:

selfobject

Обновлённый объект.