Skip to content

Commit 4f87e40

Browse files
committed
Update CHANGELOG.md
1 parent 4036554 commit 4f87e40

File tree

1 file changed

+63
-1
lines changed

1 file changed

+63
-1
lines changed

CHANGELOG.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,48 @@
11
# ExplainableAI.jl
2+
## Version `v0.5.3`
3+
Big feature release that adds LRP composites and presets:
4+
- ![Feature][badge-feature] Add LRP `Composite` and composite primitives([#84][pr-84])
5+
- ![Feature][badge-feature] Add LRP composite presets ([#87][pr-87])
6+
- ![Feature][badge-feature] Add LRP `ZPlusRule` ([#88][pr-88])
7+
- ![Enhancement][badge-enhancement] Export union-types of Flux layers for easy definition of LRP composites
8+
- ![Enhancement][badge-enhancement] Improvements to docstrings and documentation
9+
10+
## Version `v0.5.2`
11+
This release temporarily adds ImageNet pre-processing utilities. This enables users users to apply XAI methods on pretrained vision models from Metalhead.jl. *Note that this functionality will be deprecated once matching functionality is in either Metalhead.jl or MLDatasets.jl.*
12+
- ![Feature][badge-feature] Add ImageNet preprocessing utility `preprocess_imagenet` ([#80][pr-80])
13+
- ![Enhancement][badge-enhancement] Change default `heatmap` color scheme to `seismic`
14+
- ![Enhancement][badge-enhancement] Updated README with the JuliaCon 2022 talk and examples on VGG16
15+
16+
## Version `v0.5.1`
17+
Small bugfix release adressing a bug in `v0.5.0`.
18+
Version of ExplainableAI.jl shown in the JuliaCon 2022 talk.
19+
- ![Bugfix][badge-bugfix] Fix bug in `FlatRule` ([#77][pr-77])
20+
21+
## Version `v0.5.0`
22+
Breaking release that refactors the internals of `LRP` analyzers and adds several rules.
23+
24+
List of breaking changes:
25+
- ![BREAKING][badge-breaking]![Enhancement][badge-enhancement] Introduce compatibility checks for LRP rule & layer combinations using `check_compat(rule, layer)` ([#75][pr-75])
26+
- ![BREAKING][badge-breaking] Applying `GammaRule` and `ZBoxRule` on a layer without weights and biases will now throw an error ([#75][pr-75])
27+
- ![BREAKING][badge-breaking] In-place updating `modify_layer!(rule, layer)` replaces `modify_layer(rule, layer)` ([#73][pr-73])
28+
- ![BREAKING][badge-breaking] In-place updating `modify_param!(rule, param)` replaces `modify_params(rule, W, b)` ([#73][pr-73])
29+
- ![BREAKING][badge-breaking] Removed named LRP constructors `LRPZero`, `LRPEpsilon`, `LRPGamma` ([#75][pr-75])
30+
31+
Added new LRP rules:
32+
- ![Feature][badge-feature] Add `PassRule` ([#76][pr-76])
33+
- ![Feature][badge-feature] Add `AlphaBetaRule` ([#78][pr-78])
34+
- ![Feature][badge-feature] Add `FlatRule` ([a6e2c59][flat-wsquare-commit])
35+
- ![Feature][badge-feature] Add `WSquareRule` ([a6e2c59][flat-wsquare-commit])
36+
37+
Bug fixes:
38+
- ![Bugfix][badge-bugfix] Fix bug in `ZBoxRule` ([#77][pr-77])
39+
- ![Bugfix][badge-bugfix] Fix broadcasting for Julia 1.6 ([#74][pr-74])
40+
- ![Bugfix][badge-bugfix] Support `MLUtils.flatten`
41+
42+
Performance improvements:
43+
- ![Enhancement][badge-enhancement] Replace LRP gradient computation with VJP using `Zygote.pullback` ([#72][pr-72])
44+
- ![Enhancement][badge-enhancement] Faster `GammaRule`
45+
246
## Version `v0.4.0`
347
Changes:
448
- ![BREAKING][badge-breaking] Update heatmapping normalizer, using ColorScheme's `get`. Breaking due to renaming `normalize` to ColorScheme's `rangescale`. ([#57][pr-57])
@@ -21,7 +65,6 @@ Performance improvements:
2165
![Feature][badge-feature]
2266
![Enhancement][badge-enhancement]
2367
![Bugfix][badge-bugfix]
24-
![Security][badge-security]
2568
![Experimental][badge-experimental]
2669
![Maintenance][badge-maintenance]
2770
![Documentation][badge-docs]
@@ -34,6 +77,25 @@ Performance improvements:
3477
[pr-65]: https://github.com/adrhill/ExplainableAI.jl/pull/65
3578
[pr-58]: https://github.com/adrhill/ExplainableAI.jl/pull/58
3679
[pr-57]: https://github.com/adrhill/ExplainableAI.jl/pull/57
80+
[pr-58]: https://github.com/adrhill/ExplainableAI.jl/pull/57
81+
[pr-65]: https://github.com/adrhill/ExplainableAI.jl/pull/65
82+
[pr-66]: https://github.com/adrhill/ExplainableAI.jl/pull/66
83+
[pr-67]: https://github.com/adrhill/ExplainableAI.jl/pull/67
84+
[pr-69]: https://github.com/adrhill/ExplainableAI.jl/pull/69
85+
[pr-70]: https://github.com/adrhill/ExplainableAI.jl/pull/70
86+
[pr-72]: https://github.com/adrhill/ExplainableAI.jl/pull/72
87+
[pr-73]: https://github.com/adrhill/ExplainableAI.jl/pull/73
88+
[pr-74]: https://github.com/adrhill/ExplainableAI.jl/pull/74
89+
[pr-75]: https://github.com/adrhill/ExplainableAI.jl/pull/75
90+
[pr-76]: https://github.com/adrhill/ExplainableAI.jl/pull/76
91+
[pr-77]: https://github.com/adrhill/ExplainableAI.jl/pull/77
92+
[pr-78]: https://github.com/adrhill/ExplainableAI.jl/pull/78
93+
[pr-80]: https://github.com/adrhill/ExplainableAI.jl/pull/80
94+
[pr-84]: https://github.com/adrhill/ExplainableAI.jl/pull/84
95+
[pr-87]: https://github.com/adrhill/ExplainableAI.jl/pull/87
96+
[pr-88]: https://github.com/adrhill/ExplainableAI.jl/pull/88
97+
[flat-wsquare-commit]: https://github.com/adrhill/ExplainableAI.jl/commit/a6e2c59094fe4f1d4b744123de79407ccbd4b972
98+
3799

38100
[badge-breaking]: https://img.shields.io/badge/BREAKING-red.svg
39101
[badge-deprecation]: https://img.shields.io/badge/deprecation-orange.svg

0 commit comments

Comments
 (0)