DictionaryLearning

classsklearn.decomposition.DictionaryLearning(n_components=None, *, alpha=1, max_iter=1000, tol=1e-08, fit_algorithm='lars', transform_algorithm='omp', transform_n_nonzero_coefs=None, transform_alpha=None, n_jobs=None, code_init=None, dict_init=None, callback=None, verbose=False, split_sign=False, random_state=None, positive_code=False, positive_dict=False, transform_max_iter=1000)[исходный код]

Обучение словаря.

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

Решает задачу оптимизации:

(U^*,V^*) = argmin 0.5 || X - U V ||_Fro^2 + alpha * || U ||_1,1
            (U,V)
            with || V_k ||_2 <= 1 for all  0 <= k < n_components

||.||_Fro обозначает норму Фробениуса, а ||.||_1,1 — поэлементную матричную норму, которая равна сумме абсолютных значений всех элементов матрицы.

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

Параметры:

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

Количество извлекаемых элементов словаря. Если значение равно None, то n_components принимает значение n_features.

alphafloat, по умолчанию=1.0

Параметр, регулирующий разреженность.

max_iterint, по умолчанию=1000

Максимальное количество выполняемых итераций.

tolfloat, по умолчанию=1e-8

Допуск для численной ошибки.

fit_algorithm{‘lars’, ‘cd’}, по умолчанию=’lars’

• 'lars': использует метод регрессии наименьшего угла для решения задачи лассо (lars_path);
• 'cd': использует метод покоординатного спуска для вычисления решения Lasso (Lasso). Lars работает быстрее, если оценённые компоненты разрежены.

Добавлено в версии 0.17: метод покоординатного спуска cd для повышения скорости.

transform_algorithm{‘lasso_lars’, ‘lasso_cd’, ‘lars’, ‘omp’, ‘threshold’}, по умолчанию=’omp’

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

• 'lars': использует метод регрессии наименьшего угла (lars_path);
• 'lasso_lars': использует Lars для вычисления решения Lasso.
• 'lasso_cd': использует метод покоординатного спуска для вычисления решения Lasso (Lasso). 'lasso_lars' работает быстрее, если оценённые компоненты разрежены.
• 'omp': использует ортогональный жадный алгоритм сопоставления для оценки разреженного решения.
• 'threshold': обнуляет все коэффициенты проекции dictionary * X', абсолютные значения которых меньше alpha.

Добавлено в версии 0.17: метод покоординатного спуска lasso_cd для повышения скорости.

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

Целевое количество ненулевых коэффициентов в каждом столбце решения. Используется только алгоритмами algorithm='lars' и algorithm='omp'. Если задано None, то transform_n_nonzero_coefs=int(n_features / 10).

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

Если используется algorithm='lasso_lars' или algorithm='lasso_cd', alpha — это штраф, применяемый к L1-норме. Если используется algorithm='threshold', alpha — это абсолютное значение порога, ниже которого коэффициенты обнуляются. Если используется None, по умолчанию принимается значение alpha.

Изменено в версии 1.2: при значении None значение по умолчанию изменено с 1.0 на alpha.

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

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

code_initndarray формы (n_samples, n_components), по умолчанию=None

Начальное значение кода для тёплого перезапуска. Используется только если code_init и dict_init не равны None.

dict_initndarray формы (n_components, n_features), по умолчанию=None

Начальные значения словаря для тёплого перезапуска. Используются только если code_init и dict_init не равны None.

callbackвызываемый объект, по умолчанию=None

Вызываемый объект, который вызывается каждые пять итераций.

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

verbosebool, по умолчанию=False

Управляет подробностью вывода процедуры.

split_signbool, по умолчанию=False

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

random_stateint, экземпляр RandomState или None, по умолчанию=None

Используется для инициализации словаря, если dict_init не задан, для случайного перемешивания данных, если shuffle установлено в True, а также для обновления словаря. Передайте целое число, чтобы получать воспроизводимые результаты при нескольких вызовах функции. См. глоссарий.

positive_codebool, по умолчанию=False

Следует ли обеспечивать неотрицательность при поиске кода.

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

positive_dictbool, по умолчанию=False

Следует ли обеспечивать неотрицательность при поиске словаря.

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

transform_max_iterint, по умолчанию=1000

Максимальное количество выполняемых итераций, если используется algorithm='lasso_cd' или 'lasso_lars'.

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

Атрибуты:

components_ndarray формы (n_components, n_features)

атомы словаря, извлечённые из данных

error_array

вектор ошибок на каждой итерации

n_features_in_int

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

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

feature_names_in_ndarray формы (n_features_in_,)

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

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

n_iter_int

Количество выполненных итераций.

См. также

MiniBatchDictionaryLearning

Более быстрая, но менее точная версия алгоритма обучения словаря.

MiniBatchSparsePCA

Анализ главных компонент с разреженностью и мини-пакетами.

SparseCoder

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

SparsePCA

Анализ главных компонент с разреженностью.

Ссылки

J. Mairal, F. Bach, J. Ponce, G. Sapiro, 2009: Онлайн-обучение словаря для разреженного кодирования (https://www.di.ens.fr/~fbach/mairal_icml09.pdf)

Примеры

>>> import numpy as np
>>> from sklearn.datasets import make_sparse_coded_signal
>>> from sklearn.decomposition import DictionaryLearning
>>> X, dictionary, code = make_sparse_coded_signal(
...     n_samples=30, n_components=15, n_features=20, n_nonzero_coefs=10,
...     random_state=42,
... )
>>> dict_learner = DictionaryLearning(
...     n_components=15, transform_algorithm='lasso_lars', transform_alpha=0.1,
...     random_state=42,
... )
>>> X_transformed = dict_learner.fit(X).transform(X)

Можно проверить степень разреженности X_transformed:

>>> np.mean(X_transformed == 0)
np.float64(0.527)

Можно сравнить среднюю квадратичную евклидову норму ошибки восстановления разреженно закодированного сигнала с квадратичной евклидовой нормой исходного сигнала:

>>> X_hat = X_transformed @ dict_learner.components_
>>> np.mean(np.sum((X_hat - X) ** 2, axis=1) / np.sum(X ** 2, axis=1))
np.float64(0.056)

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

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

Параметры:

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

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

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

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

Возвращает:

selfobject

Возвращает сам экземпляр.

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

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

Параметры:

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

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

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

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

Возвращает:

Vndarray формы (n_samples, n_components)

Преобразованные данные.

get_feature_names_out(input_features=None)[исходный код]

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

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

Параметры:

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

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

Возвращает:

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

Названия преобразованных признаков.

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

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

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

Возвращает:

routingMetadataRequest

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

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

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

Параметры:

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

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

Возвращает:

paramsdict

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

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

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

Параметры:

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

Данные для обратного преобразования. Число компонент должно совпадать с числом компонент данных, использованных для обучения модели.

Возвращает:

X_originalndarray формы (n_samples, n_features)

Преобразованные данные.

set_output(*, transform=None)[исходный код]

Задать контейнер вывода.

Подробнее см. в руководстве пользователя; пример использования API приведён в разделе Знакомство с API set_output.

Параметры:

transform{“default”, “pandas”, “polars”}, по умолчанию=None

Настроить формат вывода для transform и fit_transform.

• "default": формат вывода преобразователя по умолчанию
• "pandas": вывод в формате DataFrame
• "polars": вывод в формате Polars
• None: конфигурация преобразования не изменяется

Добавлено в версии 1.4: добавлен параметр "polars".

Возвращает:

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

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

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

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

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

Параметры:

**paramsdict

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

Возвращает:

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

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

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

Закодировать данные как разреженную комбинацию атомов словаря.

Метод кодирования определяется параметром объекта transform_algorithm.

Параметры:

Xndarray формы (n_samples, n_features)

Тестовые данные для преобразования; число признаков должно совпадать с числом признаков данных, использованных для обучения модели.

Возвращает:

X_newndarray формы (n_samples, n_components)

Преобразованные данные.