CCA

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

Канонический корреляционный анализ, также известный как «Режим B» PLS.

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

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

Параметры:

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

Атрибуты:

x_weights_ndarray формы (n_features, n_components)

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

y_weights_ndarray формы (n_targets, n_components)

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

x_loadings_ndarray формы (n_features, n_components)

Загрузки X.

y_loadings_ndarray формы (n_targets, n_components)

Загрузки Y.

x_rotations_ndarray формы (n_features, n_components)

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

y_rotations_ndarray формы (n_targets, n_components)

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

coef_ndarray формы (n_targets, n_features)

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

intercept_ndarray формы (n_targets,)

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

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

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

Количество итераций метода мощности для каждой компоненты.

n_features_in_int

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

feature_names_in_ndarray формы (n_features_in_,)

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

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

См. также

PLSCanonical: Преобразователь и регрессор частичных наименьших квадратов.
PLSSVD: Частичные наименьшие квадраты SVD.

Примеры

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

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

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

Параметры:

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

Обучающие векторы, где n_samples — количество выборок, а n_features — количество предикторов.

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

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

Yarray-like формы (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]

Обучение и применение редукции размерности к обучающим данным.

Параметры:

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

Возвращает:

selfndarray формы (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_featuresarray-like из str или None, по умолчанию=None: Используется только для проверки имен признаков с именами, увиденными в fit.

Возвращает:

feature_names_outndarray из str объектов: Имена преобразованных признаков.

get_metadata_routing()[source]

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

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

Возвращает:

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

get_params(deep=True)[source]

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

Параметры:

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

Возвращает:

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

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

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

Параметры:

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

Новые данные, где n_samples — количество выборок, а n_components — количество компонентов PLS.

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

Новые целевые значения, где n_samples — количество выборок, а n_components — количество компонентов PLS.

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

Новые целевые значения, где n_samples — количество выборок, а n_components — количество компонентов PLS.

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

Возвращает:

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

Примечания

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

predict(X, copy=True)[source]

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

Параметры:

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

Возвращает:

y_predмассив NumPy, форма (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.

Параметры:

Xмассив-подобный, форма (n_samples, n_features): Тестовые выборки. Для некоторых оценщиков это может быть предварительно вычисленная матрица ядер или список общих объектов вместо нее с формой (n_samples, n_samples_fitted), где n_samples_fitted — количество выборок, использованных при подгонке для оценщика.
yмассив-подобный, форма (n_samples,) или (n_samples, n_outputs): Истинные значения X.
sample_weightмассив-подобный, форма (n_samples,), по умолчанию=None: Веса выборок.

Возвращает:

scorefloat: $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>, чтобы можно было обновить каждый компонент вложенного объекта.

Параметры:

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

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

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

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

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

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

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

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

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

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

Примечание

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

Параметры:

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

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

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

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

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

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

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

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

Примечание

Параметры:

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

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

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

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

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

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

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

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

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

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

Примечание

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

Parameters:

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

Returns:

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

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

Применить уменьшение размерности.

Parameters:

Xarray-like of shape (n_samples, n_features): Обрабатываемые образцы.
yarray-like of shape (n_samples, n_targets), default=None: Векторы целевых значений.
Yarray-like of shape (n_samples, n_targets), default=None: Векторы целевых значений.

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

Returns:

x_scores, y_scoresarray-like or tuple of array-like: Возвращает 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.CCA.html