ScoringExplainer Класс
Определяет модель оценки.
Если преобразования были переданы в original_explainer, эти преобразования будут перенесены в объяснитель оценки, он ожидает необработанные данные, и по умолчанию значения будут возвращены для необработанных функций. Если feature_maps передаются здесь (НЕ предназначены для использования одновременно с преобразованиями), то объяснитель ожидает преобразованные данные, и по умолчанию значения будут возвращены для преобразованных данных. В любом случае выходные данные можно указать, задав get_raw явно значение True или False в методе объяснения объяснителя.
Инициализируйте ScoringExplainer.
Если преобразования были переданы в original_explainer, эти преобразования будут перенесены в объяснитель оценки, он ожидает необработанные данные, и по умолчанию значения будут возвращены для необработанных функций. Если feature_maps передаются здесь (НЕ предназначены для использования одновременно с преобразованиями), то объяснитель ожидает преобразованные данные, и по умолчанию значения будут возвращены для преобразованных данных. В любом случае выходные данные можно указать, задав get_raw явно значение True или False в методе объяснения объяснителя.
Конструктор
ScoringExplainer(original_explainer, feature_maps=None, raw_features=None, engineered_features=None, **kwargs)Параметры
| Имя | Описание |
|---|---|
|
original_explainer
Обязательно
|
<xref:interpret_community.common.base_explainer.BaseExplainer>
Объяснение времени обучения изначально использовалось для объяснения модели. |
|
feature_maps
|
Список карт функций от необработанных к созданной функции. Список может быть числовым массивом или разреженными матрицами, где каждая запись массива (raw_index, generated_index) — это вес каждой пары необработанных признаков. Остальные записи имеют значение нулю. Для последовательности преобразований [t1, t2, ..., tn], созданных из необработанных функций, список карт функций соответствует необработанным картам для созданных карт в том же порядке, что и t1, t2 и т. д. Если доступен общий необработанный объект для созданной карты функций от t1 до tn, то можно передать только эту карту функций в одном списке элементов. Default value: None
|
|
raw_features
|
Необязательный список имен функций для необработанных функций, которые можно указать, если исходный объяснитель вычисляет объяснение по инженерным функциям. Default value: None
|
|
engineered_features
|
Необязательный список имен признаков для инженерных функций, которые можно указать, если исходный объяснитель имеет преобразования, переданные и вычисляет только важность необработанных функций. Default value: None
|
|
original_explainer
Обязательно
|
<xref:interpret_community.common.base_explainer.BaseExplainer>
Объяснение времени обучения изначально использовалось для объяснения модели. |
|
feature_maps
Обязательно
|
Список карт функций от необработанных к созданной функции. Список может быть числовым массивом или разреженными матрицами, где каждая запись массива (raw_index, generated_index) — это вес каждой пары необработанных признаков. Остальные записи имеют значение нулю. Для последовательности преобразований [t1, t2, ..., tn], созданных из необработанных функций, список карт функций соответствует необработанным картам для созданных карт в том же порядке, что и t1, t2 и т. д. Если доступен общий необработанный объект для созданной карты функций от t1 до tn, то можно передать только эту карту функций в одном списке элементов. |
|
raw_features
Обязательно
|
Необязательный список имен функций для необработанных функций, которые можно указать, если исходный объяснитель вычисляет объяснение по инженерным функциям. |
|
engineered_features
Обязательно
|
Необязательный список имен признаков для инженерных функций, которые можно указать, если исходный объяснитель имеет преобразования, переданные и вычисляет только важность необработанных функций. |
Методы
| explain |
Используйте модель для оценки, чтобы приблизить значения важности признаков данных. |
| fit |
Реализуйте фиктивный метод, необходимый для соответствия интерфейсу конвейера scikit-learn. |
| predict |
Используйте модель TreeExplainer и дерево для оценки, чтобы получить значения важности признаков данных. Упаковывает функцию .explain(). |
explain
Используйте модель для оценки, чтобы приблизить значения важности признаков данных.
abstract explain(evaluation_examples, get_raw)Параметры
| Имя | Описание |
|---|---|
|
evaluation_examples
Обязательно
|
Матрица примеров векторов признаков (#examples x #) для объяснения выходных данных модели. |
|
get_raw
Обязательно
|
Если значение True, значения важности необработанных функций будут возвращены. Если значение false, значения важности для инженерных функций будут возвращены. Если не указано и преобразования были переданы в исходный объяснитель, будут возвращены необработанные значения важности. Если не указано и feature_maps переданы в объяснитель оценки, будут возвращены инженерные значения важности. |
Возвращаемое значение
| Тип | Описание |
|---|---|
|
Для модели с одним выходным результатом, например регрессией, этот метод возвращает матрицу значений важности признаков. Для моделей с векторными выходными данными эта функция возвращает список таких матриц, по одному для каждого вывода. Измерение этой матрицы — (# примеры функций x #). |
fit
Реализуйте фиктивный метод, необходимый для соответствия интерфейсу конвейера scikit-learn.
fit(X, y=None)Параметры
| Имя | Описание |
|---|---|
|
X
Обязательно
|
Обучающие данные. |
|
y
|
Целевые показатели обучения. Default value: None
|
predict
Используйте модель TreeExplainer и дерево для оценки, чтобы получить значения важности признаков данных.
Упаковывает функцию .explain().
predict(evaluation_examples)Параметры
| Имя | Описание |
|---|---|
|
evaluation_examples
Обязательно
|
Матрица примеров векторов признаков (#examples x #) для объяснения выходных данных модели. |
Возвращаемое значение
| Тип | Описание |
|---|---|
|
Для модели с одним выходным результатом, например регрессией, это возвращает матрицу значений важности признаков. Для моделей с векторными выходными данными эта функция возвращает список таких матриц, по одному для каждого вывода. Измерение этой матрицы — (# примеры функций x #). |
Атрибуты
engineered_features
Получите имена спроектированных функций, соответствующие параметру get_raw=False при вызове объяснения.
Если в исходном объяснителье были переданы преобразования, инженерные функции необходимо передать конструктору объясняющего средства оценки с помощью параметра engineered_features. В противном случае, если карты функций были переданы объяснительу оценки, то инженерные функции будут совпадать с функциями.
Возвращаемое значение
| Тип | Описание |
|---|---|
|
Созданные имена функций или Нет, если пользователь не предоставил ни одного из них. |
features
raw_features
Получение необработанных имен функций, соответствующих параметру get_raw=True при вызове объяснения.
Если исходный объяснитель не прошел преобразования, и feature_maps были переданы объяснятелю оценки, необработанные имена признаков должны быть переданы в конструктор средства оценки с помощью параметра raw_features. В противном случае необработанные функции будут совпадать с функциями.
Возвращаемое значение
| Тип | Описание |
|---|---|
|
Необработанные имена функций или Нет, если пользователь не предоставил ни одного из них. |