Skip to content

Commit bf61828

Browse files
committed
update readme
1 parent d265f6e commit bf61828

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
![](preview.png)
44

55
[![Release](https://img.shields.io/github/release/PaddlePaddle/InterpretDL.svg)](https://github.com/PaddlePaddle/InterpretDL/releases)
6-
[![PyPI](https://img.shields.io/pypi/v/interpretdl.svg)]((https://pypi.org/project/interpretdl))
6+
[![PyPI](https://img.shields.io/pypi/v/interpretdl.svg)](https://pypi.org/project/interpretdl)
77
[![CircleCI](https://circleci.com/gh/PaddlePaddle/InterpretDL.svg?style=shield)](https://circleci.com/gh/PaddlePaddle/InterpretDL)
88
[![Documentation Status](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](https://interpretdl.readthedocs.io/en/latest/index.html)
9+
[![Downloads](https://static.pepy.tech/personalized-badge/interpretdl?period=total&units=abbreviation&left_color=grey&right_color=green&left_text=Downloads%20Total)](https://pepy.tech/project/interpretdl)
10+
911

1012
# InterpretDL: Interpretation of Deep Learning Models based on PaddlePaddle
1113

@@ -101,7 +103,7 @@ cd InterpretDL && pip install -e .
101103

102104
### Unit Tests
103105

104-
```
106+
```bash
105107
# run gradcam unit tests
106108
python -m unittest -v tests.interpreter.test_gradcam
107109
# run all unit tests
@@ -176,8 +178,9 @@ Welcome to contribute or just tell us which algorithms are desired.
176178
- [ ] Influence Function
177179

178180
* Evaluations
179-
- [ ] Deletion & Insertion
181+
- [x] Deletion & Insertion
180182
- [ ] Local Fidelity
183+
- [ ] Sensitivity
181184

182185
## Tutorials
183186

@@ -187,8 +190,9 @@ Current tutorials can be accessed under [tutorials](https://github.com/PaddlePad
187190

188191
# References of Algorithms
189192

193+
* `SGDNoise`: [On the Noisy Gradient Descent that Generalizes as SGD, Wu et al 2019](https://arxiv.org/abs/1906.07405)
190194
* `IntegratedGraients`: [Axiomatic Attribution for Deep Networks, Mukund Sundararajan et al. 2017](https://arxiv.org/abs/1703.01365)
191-
* `GradCAM`: [Grad-CAM: Visual Explanations from Deep Networks via Gradient-based Localization, Ramprasaath R. Selvaraju et al. 2017](https://arxiv.org/abs/1610.02391.pdf)
195+
* `CAM`, `GradCAM`: [Grad-CAM: Visual Explanations from Deep Networks via Gradient-based Localization, Ramprasaath R. Selvaraju et al. 2017](https://arxiv.org/abs/1610.02391.pdf)
192196
* `SmoothGrad`: [SmoothGrad: removing noise by adding noise, Daniel Smilkov et al. 2017](https://arxiv.org/abs/1706.03825)
193197
* `GradientShap`: [A Unified Approach to Interpreting Model Predictions, Scott M. Lundberg et al. 2017](http://papers.nips.cc/paper/7062-a-unified-approach-to-interpreting-model-predictions)
194198
* `Occlusion`: [Visualizing and Understanding Convolutional Networks, Matthew D Zeiler and Rob Fergus 2013](https://arxiv.org/abs/1311.2901)

README_CN.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
![](preview.png)
44

55
[![Release](https://img.shields.io/github/release/PaddlePaddle/InterpretDL.svg)](https://github.com/PaddlePaddle/InterpretDL/releases)
6-
[![PyPI](https://img.shields.io/pypi/v/interpretdl.svg)]((https://pypi.org/project/interpretdl))
6+
[![PyPI](https://img.shields.io/pypi/v/interpretdl.svg)](https://pypi.org/project/interpretdl)
77
[![CircleCI](https://circleci.com/gh/PaddlePaddle/InterpretDL.svg?style=shield)](https://circleci.com/gh/PaddlePaddle/InterpretDL)
88
[![Documentation Status](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](https://interpretdl.readthedocs.io/en/latest/index.html)
9+
[![Downloads](https://static.pepy.tech/personalized-badge/interpretdl?period=total&units=abbreviation&left_color=grey&right_color=green&left_text=Downloads%20Total)](https://pepy.tech/project/interpretdl)
910

1011
# InterpretDL: 基于『飞桨』的模型可解释性算法库
1112

@@ -100,7 +101,7 @@ cd InterpretDL && pip install -e .
100101

101102
### Unit Tests
102103

103-
```
104+
```bash
104105
# run gradcam unit tests
105106
python -m unittest -v tests.interpreter.test_gradcam
106107
# run all unit tests
@@ -176,8 +177,9 @@ gradients = sg.interpret("test.jpg", visual=True, save_path=None)
176177
- [ ] Influence Function
177178

178179
* 评估方式
179-
- [ ] Deletion & Insertion
180+
- [x] Deletion & Insertion
180181
- [ ] Local Fidelity
182+
- [ ] Sensitivity
181183

182184
## Tutorials
183185

@@ -187,8 +189,9 @@ gradients = sg.interpret("test.jpg", visual=True, save_path=None)
187189

188190
# References of Algorithms
189191

192+
* `SGDNoise`: [On the Noisy Gradient Descent that Generalizes as SGD, Wu et al 2019](https://arxiv.org/abs/1906.07405)
190193
* `IntegratedGraients`: [Axiomatic Attribution for Deep Networks, Mukund Sundararajan et al. 2017](https://arxiv.org/abs/1703.01365)
191-
* `GradCAM`: [Grad-CAM: Visual Explanations from Deep Networks via Gradient-based Localization, Ramprasaath R. Selvaraju et al. 2017](https://arxiv.org/abs/1610.02391.pdf)
194+
* `CAM`, `GradCAM`: [Grad-CAM: Visual Explanations from Deep Networks via Gradient-based Localization, Ramprasaath R. Selvaraju et al. 2017](https://arxiv.org/abs/1610.02391.pdf)
192195
* `SmoothGrad`: [SmoothGrad: removing noise by adding noise, Daniel Smilkov et al. 2017](https://arxiv.org/abs/1706.03825)
193196
* `GradientShap`: [A Unified Approach to Interpreting Model Predictions, Scott M. Lundberg et al. 2017](http://papers.nips.cc/paper/7062-a-unified-approach-to-interpreting-model-predictions)
194197
* `Occlusion`: [Visualizing and Understanding Convolutional Networks, Matthew D Zeiler and Rob Fergus 2013](https://arxiv.org/abs/1311.2901)

0 commit comments

Comments
 (0)