==== ELI5

.. image:: https://img.shields.io/pypi/v/eli5.svg :target: https://pypi.python.org/pypi/eli5 :alt: PyPI 版本

.. image:: https://travis-ci.org/TeamHG-Memex/eli5.svg?branch=master :target: https://travis-ci.org/TeamHG-Memex/eli5 :alt: 构建状态

.. image:: https://codecov.io/github/TeamHG-Memex/eli5/coverage.svg?branch=master :target: https://codecov.io/github/TeamHG-Memex/eli5?branch=master :alt: 代码覆盖率

.. image:: https://readthedocs.org/projects/eli5/badge/?version=latest :target: https://eli5.readthedocs.io/en/latest/?badge=latest :alt: 文档

ELI5 是一个 Python 包，用于调试机器学习分类器并解释其预测结果。

.. image:: https://raw.githubusercontent.com/TeamHG-Memex/eli5/master/docs/source/static/word-highlight.png :alt: 针对文本数据的预测解释

.. image:: https://raw.githubusercontent.com/TeamHG-Memex/eli5/master/docs/source/static/gradcam-catdog.png :alt: 针对图像数据的预测解释

它支持以下机器学习框架和库：

• scikit-learn_。目前 ELI5 可以解释 scikit-learn 线性分类器和回归器的权重与预测结果，将决策树以文本或 SVG 格式输出，展示特征重要性，并解释决策树及基于树的集成模型的预测。ELI5 能够理解 scikit-learn 中的文本处理工具，并相应地高亮显示文本数据。同时支持 Pipeline 和 FeatureUnion。 此外，ELI5 还可以通过反哈希化技术调试包含 HashingVectorizer 的 scikit-learn 流水线。

• Keras_ —— 通过 Grad-CAM 可视化解释图像分类器的预测结果。

• xgboost_ —— 展示特征重要性，并解释 XGBClassifier、XGBRegressor 和 xgboost.Booster 的预测结果。

• LightGBM_ —— 展示特征重要性，并解释 LGBMClassifier 和 LGBMRegressor 的预测结果。

• CatBoost_ —— 展示 CatBoostClassifier、CatBoostRegressor 和 catboost.CatBoost 的特征重要性。

• lightning_ —— 解释 lightning 分类器和回归器的权重与预测结果。

• sklearn-crfsuite_。ELI5 可以检查 sklearn_crfsuite.CRF 模型的权重。

ELI5 还实现了多种用于检查黑盒模型的算法（参见 Inspecting Black-Box Estimators_）：

• TextExplainer_ 允许使用 LIME_ 算法（Ribeiro 等，2016 年）解释任何文本分类器的预测结果。 同时也提供了一些工具，可用于非文本数据以及任意黑盒分类器的 LIME 解释，但该功能目前仍处于实验阶段。
• Permutation importance_ 方法可用于计算黑盒估计器的特征重要性。

解释与格式化是分离的；您可以获取用于在控制台显示的文本格式解释、可嵌入到 IPython 笔记本或 Web 仪表板中的 HTML 版本、如果您希望进一步处理结果则可以得到 pandas.DataFrame 对象，或者 JSON 格式以便在客户端实现自定义渲染和格式化。

.. _lightning: https://github.com/scikit-learn-contrib/lightning .. _scikit-learn: https://github.com/scikit-learn/scikit-learn .. _sklearn-crfsuite: https://github.com/TeamHG-Memex/sklearn-crfsuite .. _LIME: https://eli5.readthedocs.io/en/latest/blackbox/lime.html .. _TextExplainer: https://eli5.readthedocs.io/en/latest/tutorials/black-box-text-classifiers.html .. _xgboost: https://github.com/dmlc/xgboost .. _LightGBM: https://github.com/Microsoft/LightGBM .. _Catboost: https://github.com/catboost/catboost .. _Keras: https://keras.io/ .. _Permutation importance: https://eli5.readthedocs.io/en/latest/blackbox/permutation_importance.html .. _Inspecting Black-Box Estimators: https://eli5.readthedocs.io/en/latest/blackbox/index.html

许可证为 MIT 许可证。

更多内容请查看 文档 <https://eli5.readthedocs.io/>_。

---

.. image:: https://hyperiongray.s3.amazonaws.com/define-hg.svg :target: https://www.hyperiongray.com/?pk_campaign=github&pk_kwd=eli5 :alt: 定义 HyperionGray

ELI5 快速上手指南

ELI5 是一个 Python 库，旨在帮助开发者调试机器学习分类器并解释其预测结果。它支持多种主流框架（如 scikit-learn, XGBoost, LightGBM, Keras 等），并能以文本、HTML、DataFrame 或 JSON 格式输出解释结果。

环境准备

• 操作系统：Linux, macOS 或 Windows
• Python 版本：建议 Python 3.6 及以上
• 前置依赖：
  • 基础依赖：numpy, scipy, scikit-learn
  • 可选依赖（根据使用的模型框架安装）：
    • xgboost
    • lightgbm
    • catboost
    • keras / tensorflow (用于图像 Grad-CAM)
    • sklearn-crfsuite

安装步骤

推荐使用国内镜像源加速安装。

使用 pip 安装（推荐阿里云镜像）：

pip install eli5 -i https://mirrors.aliyun.com/pypi/simple/

安装特定框架支持（按需选择）：

# 如果需要支持 XGBoost
pip install xgboost -i https://mirrors.aliyun.com/pypi/simple/

# 如果需要支持 LightGBM
pip install lightgbm -i https://mirrors.aliyun.com/pypi/simple/

# 如果需要支持 CatBoost
pip install catboost -i https://mirrors.aliyun.com/pypi/simple/

基本使用

以下示例展示如何使用 ELI5 解释一个标准的 scikit-learn 逻辑回归模型的权重和预测结果。

1. 解释模型权重 (Explain Weights)

查看线性模型中各个特征的系数（权重）。

from sklearn.linear_model import LogisticRegression
from sklearn.datasets import load_iris
import eli5

# 加载数据并训练模型
data = load_iris()
X, y = data.data, data.target
feature_names = data.feature_names
target_names = data.target_names

clf = LogisticRegression(max_iter=200)
clf.fit(X, y)

# 解释模型权重
explanation = eli5.explain_weights(clf, target_names=target_names, feature_names=feature_names)

# 在终端打印文本解释
print(explanation)

# 如果在 Jupyter Notebook 中，可直接显示 HTML 版本
# eli5.show_weights(clf, target_names=target_names, feature_names=feature_names)

2. 解释单个预测 (Explain Prediction)

分析模型为何对某个特定样本做出该预测，并查看特征贡献度。

# 选取第一个样本进行预测解释
sample = X[0]

# 获取解释对象
exp = eli5.explain_prediction(clf, sample, target_names=target_names, feature_names=feature_names)

# 打印详细解释
print(exp)

# 在 Jupyter Notebook 中高亮显示特征贡献
# eli5.show_prediction(clf, sample, target_names=target_names, feature_names=feature_names)

3. 处理文本数据 (可选)

ELI5 能够结合 scikit-learn 的文本处理管道，高亮显示影响分类结果的关键词。

from sklearn.pipeline import Pipeline
from sklearn.feature_extraction.text import TfidfVectorizer
from sklearn.linear_model import SGDClassifier

# 构建包含向量化和分类器的管道
text_clf = Pipeline([
    ('tfidf', TfidfVectorizer()),
    ('clf', SGDClassifier(loss='log_loss'))
])

texts = ["This is a good movie", "Terrible film, I hated it"]
labels = [1, 0] # 1: Positive, 0: Negative

text_clf.fit(texts, labels)

# 解释对某段文本的预测
doc = "The movie was not good at all"
eli5.show_prediction(text_clf, doc)