Канонический PLSC

классsklearn.cross_decomposition.PLSCanonical(n_components=2, *, scale=True, algorithm='nipals', max_iter=500, tol=1e-06, copy=True)[source]

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

Для сравнения с другими алгоритмами кросс-декомпозиции, см. Сравнение методов кросс-декомпозиции.

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

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

Параметры:

n_componentsint, по умолчанию=2: Количество компонент для сохранения. Должно быть в [1, min(n_samples, n_features, n_targets)].
scalebool, по умолчанию=True: Нужно ли масштабировать X и Y.
algorithm{‘nipals’, ‘svd’}, по умолчанию=’nipals’: Алгоритм, используемый для оценки первых сингулярных векторов матрицы взаимной ковариации. «nipals» использует метод итераций, а «svd» вычисляет весь SVD.
max_iterint, по умолчанию=500: Максимальное количество итераций метода итераций, когда algorithm='nipals'. Игнорируется в противном случае.
tolfloat, по умолчанию=1e-06: Допуск, используемый как критерий сходимости в методе итераций: алгоритм останавливается, когда квадратная норма u_i - u_{i-1} меньше tol, где u соответствует левому сингулярному вектору.
copybool, по умолчанию=True: Нужно ли копировать X и Y в fit перед применением центрирования и, возможно, масштабирования. Если False, эти операции будут выполняться на месте, изменяя оба массива.

Атрибуты:

x_weights_массив формы (n_features, n_components)

Левые сингулярные векторы матриц взаимной ковариации каждой итерации.

y_weights_массив формы (n_targets, n_components)

Правые сингулярные векторы матриц взаимной ковариации каждой итерации.

x_loadings_массив формы (n_features, n_components)

Загрузки X.

y_loadings_массив формы (n_targets, n_components)

Загрузки Y.

x_rotations_массив формы (n_features, n_components)

Матрица проекций, используемая для преобразования X.

y_rotations_массив формы (n_targets, n_components)

Матрица проекций, используемая для преобразования Y.

coef_массив формы (n_targets, n_features)

Коэффициенты линейной модели, такие что Y аппроксимируется как Y = X @ coef_.T + intercept_.

intercept_массив формы (n_targets,)

Перехваты линейной модели, такие что Y аппроксимируется как Y = X @ coef_.T + intercept_.

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

n_iter_список формы (n_components,)

Количество итераций метода итераций для каждой компоненты. Пустой, если algorithm='svd'.

n_features_in_int

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

feature_names_in_массив формы (n_features_in_,)

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

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

См. также

CCA: Канонический корреляционный анализ.
PLSSVD: Метод главных компонент SVD.

Примеры

>>> from sklearn.cross_decomposition import PLSCanonical
>>> X = [[0., 0., 1.], [1.,0.,0.], [2.,2.,2.], [2.,5.,4.]]
>>> y = [[0.1, -0.2], [0.9, 1.1], [6.2, 5.9], [11.9, 12.3]]
>>> plsca = PLSCanonical(n_components=2)
>>> plsca.fit(X, y)
PLSCanonical()
>>> X_c, y_c = plsca.transform(X, y)

fit(X, y=None, Y=None)[source]

Обучить модель данным.

Параметры:

Xмассив-подобный формы (n_samples, n_features)

Векторы обучения, где n_samples — количество выборок, а n_features — количество предикторов.

yмассив-подобный формы (n_samples,) или (n_samples, n_targets)

Векторы целевых переменных, где n_samples — количество выборок, а n_targets — количество переменных отклика.

Yмассив-подобный формы (n_samples,) или (n_samples, n_targets)

Векторы целевых переменных, где n_samples — количество выборок, а n_targets — количество переменных отклика.

Устаревшее с версии 1.5: Y устарело в версии 1.5 и будет удалено в версии 1.7. Используйте y вместо этого.

Возвращает:

selfобъект: Обученная модель.

fit_transform(X, y=None)[source]

Обучить и применить уменьшение размерности к данным обучения.

Параметры:

Xмассив-подобный формы (n_samples, n_features): Векторы обучения, где n_samples — количество выборок, а n_features — количество предикторов.
yмассив-подобный формы (n_samples, n_targets), по умолчанию=None: Векторы целевых переменных, где n_samples — количество выборок, а n_targets — количество переменных отклика.

Возвращает:

selfмассив формы (n_samples, n_components): Возвращает x_scores если Y не задано, (x_scores, y_scores) в противном случае.

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]

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

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

Возвращает:

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

get_params(deep=True)[source]

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

Параметры:

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

Возвращает:

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

inverse_transform(X, y=None, Y=None)[source]

Преобразовать данные обратно в исходное пространство.

Параметры:

Xarray-like формы (n_samples, n_components): Новые данные, где n_samples — число выборок, а n_components — число компонент PLS.
yarray-like формы (n_samples,) или (n_samples, n_components): Новые целевые значения, где n_samples — число выборок, а n_components — число компонент PLS.
Yarray-like формы (n_samples, n_components): Новые целевые значения, где n_samples — число выборок, а n_components — число компонент PLS.

Устарело начиная с версии 1.5: Y устарело в версии 1.5 и будет удалено в версии 1.7. Используйте y вместо этого.

Возвращает:

X_восстановленныеndarray формы (n_samples, n_features): Возвращает восстановленные X данные.
y_восстановленныеndarray формы (n_samples, n_targets): Возвращает восстановленные X целевые значения. Возвращается только при указании y.

Примечания

Это преобразование будет точным только если n_components=n_features.

predict(X, copy=True)[source]

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

Параметры:

Xarray-like формы (n_samples, n_features): Выборки.
copybool, по умолчанию=True: Копировать X и Y, или выполнить нормализацию на месте.

Возвращает:

y_предсказанныеndarray формы (n_samples,) или (n_samples, n_targets): Возвращает предсказанные значения.

Примечания

Этот вызов требует оценки матрицы формы (n_features, n_targets), что может быть проблемой в высоких измерениях.

score(X, y, sample_weight=None)[source]

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

Коэффициент детерминации $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: Веса выборок.

Возвращает:

результатfloat: $R^2$ self.predict(X) относительно y.

Примечания

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

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

set_predict_request(*, copy:bool|None|str='$UNCHANGED$') → PLSCanonical[source]

Запрос метаданных, передаваемых методу predict.

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

Варианты для каждого параметра:

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

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

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

Примечание

Этот метод актуален только если этот оценщик используется как под-оценщик мета-оценщика, например, внутри Pipeline. В противном случае он не оказывает влияния.

Parameters:

copystr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED: Маршрутизация метаданных для параметра copy в predict.

Returns:

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

set_score_request(*, sample_weight:bool|None|str='$UNCHANGED$') → PLSCanonical[source]

Запрос метаданных, передаваемых методу score.

Варианты для каждого параметра:

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

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

Примечание

Parameters:

sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED: Маршрутизация метаданных для параметра sample_weight в score.

Returns:

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

set_transform_request(*, copy:bool|None|str='$UNCHANGED$') → PLSCanonical[source]

Запрос метаданных, передаваемых методу transform.

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

Варианты для каждого параметра:

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

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

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

Примечание

Этот метод актуален только если этот оценщик используется в качестве под-оценщика мета-оценщика, например, внутри Pipeline. В противном случае он не имеет эффекта.

Параметры:

copystr, True, False, или None, по умолчанию sklearn.utils.metadata_routing.UNCHANGED: Маршрутизация метаданных для параметра copy в transform.

Возвращает:

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

transform(X, y=None, Y=None, copy=True)[source]

Применение сокращения размерности.

Параметры:

Xмассив-подобный с формой (n_samples, n_features): Преобразуемые выборки.
yмассив-подобный с формой (n_samples, n_targets), по умолчанию None: Векторы целевых значений.
Yмассив-подобный с формой (n_samples, n_targets), по умолчанию None: Векторы целевых значений.

Устарело с версии 1.5: Y устарело в 1.5 и будет удалено в 1.7. Используйте y вместо этого.
copybool, по умолчанию True: Копировать X и Y, или выполнить нормализацию на месте.

Возвращает:

x_scores, y_scoresмассив-подобный или кортеж массивов-подобных: Возвращает x_scores если Y не задан, (x_scores, y_scores) в противном случае.

Галерея примеров

Сравнение методов кросс-декомпозиции

© 2007–2025 The scikit-learn developers
Licensed under the 3-clause BSD License.
https://scikit-learn.org/1.6/modules/generated/sklearn.cross_decomposition.PLSCanonical.html