1- # ExplainabilityMethods.jl
1+ ![ ExplainabilityMethods.jl] ( https://raw.githubusercontent.com/adrhill/ExplainabilityMethods.jl/gh-pages/assets/banner.svg )
2+ ___
23
3- [ ![ Stable] ( https://img.shields.io/badge/docs-stable-blue.svg )] ( https://adrhill.github.io/ExplainabilityMethods.jl/stable )
4- [ ![ Dev] ( https://img.shields.io/badge/docs-dev-blue.svg )] ( https://adrhill.github.io/ExplainabilityMethods.jl/dev )
5- [ ![ Build Status] ( https://github.com/adrhill/ExplainabilityMethods.jl/workflows/CI/badge.svg )] ( https://github.com/adrhill/ExplainabilityMethods.jl/actions )
6- [ ![ Coverage] ( https://codecov.io/gh/adrhill/ExplainabilityMethods.jl/branch/master/graph/badge.svg )] ( https://codecov.io/gh/adrhill/ExplainabilityMethods.jl )
4+ | ** Documentation** | ** Build Status** |
5+ | :--------------------------------------------------------------------- | :----------------------------------------------------- |
6+ | [ ![ ] [ docs-stab-img ]] [ docs-stab-url ] [ ![ ] [ docs-dev-img ]] [ docs-dev-url ] | [ ![ ] [ ci-img ]] [ ci-url ] [ ![ ] [ codecov-img ]] [ codecov-url ] |
77
8- Explainable AI (XAI) in Julia using Flux.
8+ Explainable AI in Julia using Flux.
99
1010## Installation
1111To install this package and its dependencies, open the Julia REPL and run
1212``` julia-repl
1313julia> ]add https://github.com/adrhill/ExplainabilityMethods.jl
1414```
1515
16- ⚠️ This package is in early development, so expect frequent breaking changes ⚠️
16+ ⚠️ This package is in early development, so expect frequent breaking changes. ⚠️
1717
1818## Example
1919``` julia
2020using Flux
2121using Metalhead
2222using ExplainabilityMethods
2323
24- # Load VGG model
24+ # Load model
2525vgg = VGG19 ()
2626model = strip_softmax (vgg. layers)
2727
@@ -46,3 +46,16 @@ Currently, the following analyzers are implemented:
4646
4747One of the design goals of ExplainabilityMethods.jl is extensibility.
4848Individual LRP rules like ` ZeroRule ` , ` EpsilonRule ` , ` GammaRule ` and ` ZBoxRule ` can be composed and are easily extended by custom rules.
49+
50+
51+ [ docs-stab-img ] : https://img.shields.io/badge/docs-stable-blue.svg
52+ [ docs-stab-url ] : https://adrhill.github.io/ExplainabilityMethods.jl/stable
53+
54+ [ docs-dev-img ] : https://img.shields.io/badge/docs-main-blue.svg
55+ [ docs-dev-url ] : https://adrhill.github.io/ExplainabilityMethods.jl/dev
56+
57+ [ ci-img ] : https://github.com/adrhill/ExplainabilityMethods.jl/workflows/CI/badge.svg
58+ [ ci-url ] : https://github.com/adrhill/ExplainabilityMethods.jl/actions
59+
60+ [ codecov-img ] : https://codecov.io/gh/adrhill/ExplainabilityMethods.jl/branch/master/graph/badge.svg
61+ [ codecov-url ] : https://codecov.io/gh/adrhill/ExplainabilityMethods.jl
0 commit comments