Skip to content

Commit af38a1f

Browse files
committed
Small fixes to readme
1 parent 3a2065b commit af38a1f

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
![ExplainableAI.jl][banner-img]
22
___
33

4-
*Formerly known as ExplainabilityMethods.jl*
5-
64
| **Documentation** | **Build Status** | **DOI** |
75
|:--------------------------------------------------------------------- |:----------------------------------------------------- |:----------------------- |
86
| [![][docs-stab-img]][docs-stab-url] [![][docs-dev-img]][docs-dev-url] | [![][ci-img]][ci-url] [![][codecov-img]][codecov-url] | [![][doi-img]][doi-url] |
@@ -19,7 +17,9 @@ julia> ]add ExplainableAI
1917

2018
## Example
2119
Let's use LRP to explain why an image of a castle gets classified as such using a pre-trained VGG16 model from [Metalhead.jl](https://github.com/FluxML/Metalhead.jl):
20+
2221
![][castle]
22+
2323
```julia
2424
using ExplainableAI
2525
using Flux
@@ -54,7 +54,7 @@ heatmap(input, analyzer, 920) # for heatmap
5454
Heatmaps for all implemented analyzers are shown in the following table. Red color indicate regions of positive relevance towards the selected class, whereas regions in blue are of negative relevance.
5555

5656
| **Analyzer** | **Heatmap for class "castle"** |**Heatmap for class "street sign"** |
57-
|:--------------------- |:------------------------------ |:---------------------------------- |
57+
|:--------------------- |:------------------------------:|:----------------------------------:|
5858
| `LRP` composite | ![][castle-lrp-comp] | ![][streetsign-lrp-comp] |
5959
| `LRP` | ![][castle-lrp] | ![][streetsign-lrp] |
6060
| `InputTimesGradient` | ![][castle-ixg] | ![][streetsign-ixg] |
@@ -64,6 +64,11 @@ Heatmaps for all implemented analyzers are shown in the following table. Red col
6464

6565
The code used to generate these heatmaps can be found [here][asset-code].
6666

67+
## Video demonstration
68+
Check out our talk at JuliaCon 2022 for a demonstration of the package.
69+
70+
[![][juliacon-img]][juliacon-url]
71+
6772
## Methods
6873
Currently, the following analyzers are implemented:
6974

@@ -86,10 +91,6 @@ Currently, the following analyzers are implemented:
8691
One of the design goals of ExplainableAI.jl is extensibility.
8792
Individual LRP rules [can be composed][docs-composites] and are easily extended by [custom rules][docs-custom-rules].
8893

89-
## Video demonstration
90-
Check out our [JuliaCon 2022 talk][juliacon-url] for a demonstration of the package.
91-
[![][juliacon-img]][juliacon-url]
92-
9394
## Roadmap
9495
In the future, we would like to include:
9596
- [PatternNet](https://arxiv.org/abs/1705.05598)

0 commit comments

Comments
 (0)