Skip to content

Commit 10f72fd

Browse files
committed
Update readme
1 parent bef83fc commit 10f72fd

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,27 @@ julia> ]add https://github.com/adrhill/ExplainabilityMethods.jl
1616
This package is in early development. Expect [breaking changes on minor version updates](https://semver.org/#spec-item-4) until version `1.0.0`.
1717

1818
## Example
19+
Let's use LRP to explain why an image of a cat gets classified as a cat:
1920
```julia
21+
using ExplainabilityMethods
2022
using Flux
2123
using Metalhead
22-
using ExplainabilityMethods
2324

2425
# Load model
2526
vgg = VGG19()
2627
model = strip_softmax(vgg.layers)
2728

2829
# Run XAI method
2930
analyzer = LRPEpsilon(model)
30-
expl, out = analyze(img, analyzer)
31+
expl, out = analyze(img, analyzer)
3132

3233
# Show heatmap
3334
heatmap(expl)
3435
```
36+
![][heatmap]
3537

38+
39+
## Methods
3640
Currently, the following analyzers are implemented:
3741

3842
```
@@ -45,9 +49,10 @@ Currently, the following analyzers are implemented:
4549
```
4650

4751
One of the design goals of ExplainabilityMethods.jl is extensibility.
48-
Individual LRP rules like `ZeroRule`, `EpsilonRule`, `GammaRule` and `ZBoxRule` can be composed and are easily extended by custom rules.
52+
Individual LRP rules like `ZeroRule`, `EpsilonRule`, `GammaRule` and `ZBoxRule` [can be composed][docs-composites] and are easily extended by [custom rules][docs-custom-rules].
4953

5054
[banner-img]: https://raw.githubusercontent.com/adrhill/ExplainabilityMethods.jl/gh-pages/assets/banner.png
55+
[heatmap]: https://raw.githubusercontent.com/adrhill/ExplainabilityMethods.jl/gh-pages/assets/heatmap.png
5156

5257
[docs-stab-img]: https://img.shields.io/badge/docs-stable-blue.svg
5358
[docs-stab-url]: https://adrhill.github.io/ExplainabilityMethods.jl/stable
@@ -60,3 +65,6 @@ Individual LRP rules like `ZeroRule`, `EpsilonRule`, `GammaRule` and `ZBoxRule`
6065

6166
[codecov-img]: https://codecov.io/gh/adrhill/ExplainabilityMethods.jl/branch/master/graph/badge.svg
6267
[codecov-url]: https://codecov.io/gh/adrhill/ExplainabilityMethods.jl
68+
69+
[docs-composites]: https://adrhill.github.io/ExplainabilityMethods.jl/dev/generated/example/#Custom-composites
70+
[docs-custom-rules]: https://adrhill.github.io/ExplainabilityMethods.jl/dev/generated/example/#Custom-rules

0 commit comments

Comments
 (0)