Project Icon

AIX360

全面支持多种数据类型和机器学习模型解释的开源工具包

工具包提供全面支持机器学习模型和数据集的可解释性,涵盖多种解释算法和指标,包括表格、文本、图像及时间序列数据。该项目提供互动体验、教程和示例,并提供指导材料和分类树帮助选择算法。工具包易于扩展,欢迎贡献新的算法、指标和用例。

AI可解释性360 (v0.3.0)

Build Documentation Status PyPI version

AI可解释性360工具包是一个开源库,支持数据集和机器学习模型的可解释性和可解释性。AI可解释性360 Python包包括一整套算法,涵盖了不同维度的解释以及代理可解释性指标。AI可解释性360工具包支持表格数据、文本、图像和时间序列数据。

AI可解释性360互动体验通过不同消费者角色的示例用例,提供了一个温和的介绍。 教程和示例笔记本提供了更深层次的数据科学家导向的介绍。完整的API也可用。

没有一种单一的可解释性方法是最好的。有许多解释方式:数据 vs 模型,直接可解释 vs 事后解释,局部 vs 全局等。因此,可能很难确定哪些算法最适合特定的用例。为此,我们创建了一些指导材料和一个分类树供参考。

我们在开发这个包时考虑了可扩展性。这个库还在开发中。我们鼓励您贡献您的可解释性算法、指标和用例。如需作为贡献者入门,请通过这里请求邀请后加入AI可解释性360社区。请查看贡献代码和Python笔记本的说明

支持的可解释性算法

数据解释

局部事后解释

时间序列局部事后解释

  • 用集成梯度生成的时间序列显著性图(Inspired by Sundararajan等
  • 时间序列LIME(时间序列适配经典论文Ribeiro等,2016
  • 时间序列个体条件期望(时间序列适配个体条件期望图Goldstein等

局部直接解释

认证的局部解释

全局直接解释

全局事后解释

支持的可解释性指标

设置

支持的配置:

安装关键字解释器操作系统Python版本
cofrnetcofrnetmacOS, Ubuntu, Windows3.10
contrastivecem, cem_mafmacOS, Ubuntu, Windows3.6
dipvaedipvaemacOS, Ubuntu, Windows3.10
gcegcemacOS, Ubuntu, Windows3.10
ecertifyecertifymacOS, Ubuntu, Windows3.10
imdimdmacOS, Ubuntu3.10
limelimemacOS, Ubuntu, Windows3.10
matchingmatchingmacOS, Ubuntu, Windows3.10
nncontrastivenncontrastivemacOS, Ubuntu, Windows3.10
profwtprofwtmacOS, Ubuntu, Windows3.6
protodashprotodashmacOS, Ubuntu, Windows3.10
rbmbrcg, glrmmacOS, Ubuntu, Windows3.10
rule_inductionrippermacOS, Ubuntu, Windows3.10
shapshapmacOS, Ubuntu, Windows3.6
tedtedmacOS, Ubuntu, Windows3.10
tsicetsicemacOS, Ubuntu, Windows3.10
tslimetslimemacOS, Ubuntu, Windows3.10
tssaliencytssaliencymacOS, Ubuntu, Windows3.10

(可选)创建虚拟环境

AI Explainability 360 需要特定版本的许多 Python 包,这些包可能与系统上的其他项目冲突。强烈建议使用虚拟环境管理器以确保依赖关系能够安全安装。如果您在安装工具包时遇到问题,请首先尝试此方法。

Conda

推荐使用 Conda,但虚拟环境通常也可以互换使用。Miniconda 就足够了(有关 Anaconda 和 Miniconda 之间的区别,请参见此处),如果您尚未安装,可以从这里下载。

然后,根据您希望使用的可解释性算法,通过参考上表,创建一个新的 Python 环境。例如,对于 Python 3.10,使用以下命令:

conda create --name aix360 python=3.10
conda activate aix360

命令提示符应该现在显示 (aix360) $。要退出环境,运行:

(aix360)$ conda deactivate

提示符将返回到 $ (base)$

注意: 较旧版本的 conda 可能使用 source activate aix360source deactivate(在 Windows 上使用 activate aix360deactivate)。

安装

克隆本仓库的最新版本:

(aix360)$ git clone https://github.com/Trusted-AI/AIX360

如果您想运行示例和教程笔记本,现在下载数据集并将其放在各自的文件夹中,新详细描述见 aix360/data/README.md

然后,导航到包含 setup.py 文件的项目根目录并运行:

(aix360)$ pip install -e .[<algo1>,<algo2>, ...]

上述命令安装特定算法所需的程序包。这里 <algo> 指的是上面中的安装关键词。例如,要安装 BRCG、DIPVAE 和 TSICE 算法需要的包,可以使用

(aix360)$ pip install -e .[rbm,dipvae,tsice]

默认命令 pip install . 仅安装默认依赖

请注意,您可能无法在同一环境中安装需要不同版本的 python 的两个算法(例如 contrastiverbm)。

如果您遇到任何问题,请尝试升级 pip 和 setuptools 并卸载任何以前版本的 aix360,然后再尝试上述步骤。

(aix360)$ pip install --upgrade pip setuptools
(aix360)$ pip uninstall aix360

AI Explainability 360 的 PIP 安装

如果您想快速开始使用 AI explainability 360 工具包而不明确克隆此存储库,可以使用以下选项之一:

  • 通过存储库链接安装 v0.3.0
(your environment)$ pip install -e git+https://github.com/Trusted-AI/AIX360.git#egg=aix360[<algo1>,<algo2>,...]

例如,使用 pip install -e git+https://github.com/Trusted-AI/AIX360.git#egg=aix360[rbm,dipvae,tsice] 安装 BRCG、DIPVAE 和 TSICE。如果环境中尚未安装 cmake,可以使用 conda install cmake 安装。

  • 通过 pypi 安装 v0.3.0(或以前版本)
(your environment)$ pip install aix360

如果您遵循上述任一选项,您需要单独下载 examples 文件夹中提供的笔记本。

处理安装错误

AI Explainability 360 工具包在 Windows、MacOS 和 Linux 上进行了测试。然而,如果您仍然因包依赖问题遇到安装问题,请尝试通过 conda 安装相应的包(例如 conda install package-name),然后按照常规步骤继续安装工具包。例如,如果您在安装过程中与 pygraphviz 相关的问题,使用 conda install pygraphviz,然后安装工具包。

请根据上方中的信息使用正确的 python 环境。

在 Docker 中运行

  • AIX360 目录下,通过 docker build -t aix360_docker . 从 Dockerfile 构建容器镜像
  • 使用命令 docker run -it -p 8888:8888 aix360_docker:latest bash 启动容器镜像,假设您的机器上端口 8888 是空闲的
  • 在容器内使用命令 jupyter lab --allow-root --ip 0.0.0.0 --port 8888 --no-browser 启动 jupyter lab
  • 使用 URL localhost:8888 在您的机器上访问示例教程

使用 AI Explainability 360

examples 目录包含一系列使用 AI Explainability 360 各种方式的 jupyter 笔记本。示例和教程笔记本都展示了使用该工具包的实际代码。教程提供了额外的讨论,详细介绍了笔记本的各个步骤。请参阅此处的教程和示例详细信息。

引用 AI Explainability 360

如果您在工作中使用 AI Explainability 360,我们鼓励您

  • 引用以下论文。bibtex 条目如下:
@misc{aix360-sept-2019,
title = "One Explanation Does Not Fit All: A Toolkit and Taxonomy of AI Explainability Techniques",
author = {Vijay Arya and Rachel K. E. Bellamy and Pin-Yu Chen and Amit Dhurandhar and Michael Hind
and Samuel C. Hoffman and Stephanie Houde and Q. Vera Liao and Ronny Luss and Aleksandra Mojsilovi\'c
and Sami Mourad and Pablo Pedemonte and Ramya Raghavendra and John Richards and Prasanna Sattigeri
and Karthikeyan Shanmugam and Moninder Singh and Kush R. Varshney and Dennis Wei and Yunfeng Zhang},
month = sept,
year = {2019},
url = {https://arxiv.org/abs/1909.03012}
}

AIX360 视频

  • Vijay Arya 和 Amit Dhurandhar 介绍 AI Explainability 360 的视频,2019 年 9 月 5 日(35 分钟)

致谢

AIX360 是在若干开源包的帮助下构建的。这些包都列在 setup.py 中,其中包括:

许可信息

请查看根目录中 LICENSE 文件和文件夹 supplementary license 了解许可证信息。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号