KNeighborsRegressor

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

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

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

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

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

Параметры:

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

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

weights{‘uniform’, ‘distance’}, вызываемый объект или None, по умолчанию=’uniform’

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

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

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

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

algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, по умолчанию=’auto’

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

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

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

leaf_sizeint, по умолчанию=30

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

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

Степенной параметр метрики Минковского. При p = 1 он соответствует использованию расстояния Манхэттена (l1), а при p = 2 — евклидова расстояния (l2). Для произвольного p используется расстояние Минковского (l_p).

metricstr, объект DistanceMetric или вызываемый объект, по умолчанию=’minkowski’

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

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

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

Если metric — объект DistanceMetric, он будет передан непосредственно базовым вычислительным процедурам.

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

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

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

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

Атрибуты:

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

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

См. также

NearestNeighbors

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

RadiusNeighborsRegressor

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

KNeighborsClassifier

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

RadiusNeighborsClassifier

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

Примечания

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

Предупреждение

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

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

Примеры

>>> X = [[0], [1], [2], [3]]
>>> y = [0, 0, 1, 1]
>>> from sklearn.neighbors import KNeighborsRegressor
>>> neigh = KNeighborsRegressor(n_neighbors=2)
>>> neigh.fit(X, y)
KNeighborsRegressor(...)
>>> print(neigh.predict([[1.5]]))
[0.5]

fit(X, y)[источник]

Обучает регрессор на основе k ближайших соседей по обучающему набору данных.

Параметры:

X{array-like, разреженная матрица} формы (n_samples, n_features) или (n_samples, n_samples), если metric=’precomputed’

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

y{array-like, разреженная матрица} формы (n_samples,) или (n_samples, n_outputs)

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

Возвращает:

selfKNeighborsRegressor

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

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, разреженная матрица}, форма (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, а сам он является третьим элементом выборки (индексация начинается с 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, разреженная матрица} формы (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’ рёбра содержат расстояния между точками, тип которых зависит от параметра метрики, выбранной в классе 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.]])

predict(X)[источник]

Прогнозирует целевые значения для предоставленных данных.

Параметры:

X{array-like, разреженная матрица} формы (n_queries, n_features) или (n_queries, n_indexed), если metric == ‘precomputed’, или None

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

Возвращает:

yndarray формы (n_queries,) или (n_queries, n_outputs), dtype=int

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

score(X, y, sample_weight=None)[источник]

Возвращает коэффициент детерминации для тестовых данных.

Коэффициент детерминации \(R^2\) определяется как \((1 - \frac{u}{v})\), где \(u\) — сумма квадратов остатков ((y_true - y_pred)** 2).sum(), а \(v\) — общая сумма квадратов ((y_true - y_true.mean()) ** 2).sum(). Наилучшая возможная оценка равна 1.0, но она может быть отрицательной (поскольку модель может быть сколь угодно хуже). Константная модель, всегда прогнозирующая ожидаемое значение y и не учитывающая входные признаки, получит оценку \(R^2\), равную 0.0.

Параметры:

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

Тестовые образцы. Для некоторых оценщиков это может быть предварительно вычисленная матрица ядра или список произвольных объектов вместо этого, формы (n_samples, n_samples_fitted), где n_samples_fitted — количество образцов, использованных при обучении оценщика.

yarray-like формы (n_samples,) или (n_samples, n_outputs)

Истинные значения для X.

sample_weightarray-like формы (n_samples,), по умолчанию=None

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

Возвращает:

scorefloat

\(R^2\) для self.predict(X) относительно y.

Примечания

Оценка \(R^2\), используемая при вызове score для регрессора, начиная с версии 0.23 использует multioutput='uniform_average' для согласования со значением по умолчанию r2_score. Это влияет на метод score всех регрессоров с несколькими выходами (за исключением MultiOutputRegressor).

set_params(**params)[источник]

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

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

Параметры:

**paramsdict

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

Возвращает:

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

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

set_score_request(*, sample_weight:bool|None|str='$UNCHANGED$') → KNeighborsRegressor[источник]

Настраивает, следует ли запрашивать передачу метаданных методу 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 или None, по умолчанию=sklearn.utils.metadata_routing.UNCHANGED

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

Возвращает:

selfobject

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