# xai

**Repository Path**: ngtony/xai

## Basic Information

- **Project Name**: xai
- **Description**: Explainable AI on MindSpore.
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 20
- **Created**: 2021-06-09
- **Last Updated**: 2022-10-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 可解释AI (XAI)

[View English](./README.md)

<!-- TOC --->

- [什么是可解释AI (XAI)](#什么是可解释ai-xai)
    - [系统架构](#系统架构)
- [安装教程](#安装教程)
    - [系统要求](#系统要求)
    - [pip安装](#pip安装)
    - [从源码安装](#从源码安装)
    - [验证是否安装成功](#验证是否安装成功)
- [注意事項](#注意事項)
- [快速入门及API文档](#快速入门及API文档)
- [社区](#社区)
    - [治理](#治理)
- [贡献](#贡献)
- [许可证](#许可证)

<!-- /TOC -->

## 什么是可解释AI (XAI)

XAI是一个基于 [MindSpore](https://www.mindspore.cn/en) 的可解释AI工具箱。当前深度学习模型多为黑盒模型，性能表现好但可解释性较差。XAI旨在为用户提供对模型决策依据的解释，帮助用户更好地理解模型、信任模型，以及当模型出现错误时有针对性地改进模型效果。除了提供多种解释方法，还提供了一套对解释方法效果评分的度量方法，从多种维度评估解释方法的效果，从而帮助用户比较和选择最适合于特定场景的解释方法。

### 系统架构

![sys_arch](./images/sys_arch_cn.png)

## 安装教程

### 系统要求

- 操作系统: EulerOS-aarch64、CentOS-aarch64、CentOS-x86、Ubuntu-aarch64 或 Ubuntu-x86
- 硬件平台: Ascend 910 或 GPU CUDA 10.1、11.1
- Python 3.7.5 或 3.9.0
- MindSpore 1.7 或以上

### pip安装

最简单的做法:

```bash
pip install mindspore-xai
```

或者从[MindSpore XAI下载页面](https://www.mindspore.cn/versions)下载并安装whl包。

```bash
pip install mindspore_xai-{version}-py3-none-any.whl
```

### 从源码安装

1. 从gitee.com下载源码：

```bash
git clone https://gitee.com/mindspore/xai.git
```

2. 安装所有依赖的Python包：

```bash
cd xai
pip install -r requirements.txt
```

3. 从源码安装XAI：

```bash
python setup.py install
```

4. 你也可以跳过第三步，打包一个`.whl`安装包:

```bash
bash package.sh
pip install output/mindspore_xai-{version}-py3-none-any.whl
```

### 验证是否安装成功

成功安装后，在Python运行以下代码会印出已安装的XAI版本：

```python
import mindspore_xai
print(mindspore_xai.__version__)
```

## 快速入门及API文档

关于如何快速使用XAI为模型进行解释及API文档，请点击查看[XAI官網](https://www.mindspore.cn/xai/docs/zh-CN/master/index.html)。

## 社区

### 治理

查看MindSpore如何进行[开放治理](https://gitee.com/mindspore/community/blob/master/governance.md)。

## 贡献

欢迎参与贡献。更多详情，请参阅我们的[贡献者Wiki](https://gitee.com/mindspore/mindspore/blob/master/CONTRIBUTING.md)。

## 许可证

[Apache License 2.0](LICENSE)