用于评估和部署人类可读机器学习解释的库。
项目描述
Pyreal
更易于理解模型预测的方法。
| 重要链接 | |
|---|---|
| :book: 文档 | 快速入门和用户指南 |
| :memo: API参考 | 完整的库API |
| :apple: 教程 | 示例用法笔记本 |
| :scroll: 许可协议 | 此仓库采用MIT许可协议发布 |
| :computer: 项目主页 | 访问Sibyl项目网站获取更多信息 |
概述
Pyreal 以低代码方式为您提供易于理解的机器学习模型解释。Pyreal 将完整的 ML 管道封装在 RealApp 对象中，使其易于使用、理解和交互，无论您的 ML 熟悉程度如何。
查看我们的教程系列，了解如何使用 Pyreal 进行房价预测的示例
安装
要求
Pyreal 已在 Python 3.9、3.10 和 3.11 上开发和测试。该库使用 Poetry 进行包管理。
从 PyPI 安装
我们建议使用 pip 来安装 Pyreal
pip install pyreal
这将从 PyPI 拉取并安装最新的稳定版本。
从源代码安装
如果您没有安装 poetry，请访问 poetry 安装指南 并按照说明安装 poetry。
运行以下命令以确保 poetry 已激活。您可能需要关闭并重新打开终端。
poetry --version
最后，您可以通过运行 poetry install 从源代码克隆此存储库并安装它，如果需要运行我们的教程脚本，可以添加可选的 examples 附加组件。
git clone https://github.com/sibyl-dev/pyreal.git
cd pyreal
poetry install
为开发安装
如果您想为项目做出贡献，还需要进行一些额外的步骤来使项目准备好开发。
有关此过程的更多信息，请参阅 贡献指南。
快速入门
在本简短教程中，我们将引导您完成一些步骤，以开始使用 Pyreal。我们将使用 RealApp 对象来获取对泰坦尼克号乘客是否存活的预测和解释。
有关本教程的更详细版本，请参阅 我们的文档。
加载示例数据和应用程序
import pyreal.sample_applications.titanic as titanic
real_app = titanic.load_app()
sample_data = titanic.load_data(n_rows=300)
预测并生成解释
predictions = real_app.predict(sample_data)
explanation = real_app.produce_feature_contributions(sample_data)
可视化单个乘客的解释
passenger_id = 1
feature_bar_plot(explanation[passenger_id], prediction=predictions[passenger_id], show=False)
输出将是一个条形图，显示按绝对值计算的贡献最大的特征。
我们可以看到，由于输入乘客的性别（男性）和船票等级（三等），其预测的生存概率大大降低。
将您的应用程序迁移到 Pyreal
要为您的应用程序创建 RealApp 对象，请参阅我们的 迁移教程。
对于基于 sklearn 管道的简单应用程序，您可能只需简单使用
from pyreal import RealApp
pipeline = # YOUR SKLEARN PIPELINE
X_train, y_train = # YOUR TRAINING DATA
real_app = RealApp.from_sklearn(pipeline, X_train=X_train, y_train=y_train)
下一步
有关使用 Pyreal 解决您用例的更多信息，请访问完整的 文档网站。
下载文件
下载您平台对应的文件。如果您不确定选择哪一个，请了解更多关于 安装包 的信息。
源代码分发
构建分发
pyreal-0.4.10.tar.gz 的散列
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | e1f5d60ed29467bbb34391248c37df038fd35ba033e38e85fb4e19744290a6a8 |
|
| MD5 | 44791f4a9c28988b7761ed31c996eff6 |
|
| BLAKE2b-256 | cdddb6ffcd3034d4e902af8335e5d862f80b992b4ffcb7d6c3367df9de5cf045 |
pyreal-0.4.10-py3-none-any.whl 的散列
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | 4205a6d129be3ba3528b8023e72566bc13de0c57fb24fc25b4e77fc12123011e |
|
| MD5 | e101e4b428e8bedc9afc4a074187db93 |
|
| BLAKE2b-256 | fb89c00be3aa7b9d11257c39ab7f66e656597f95776826e608e63faf74aa8d99 |