Skip to content

Commit e084f2b

Browse files
committed
Update changelog
1 parent 5ef7d06 commit e084f2b

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

CHANGELOG.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Breaking changes:
1616
- `GammaRule`: argument `gamma` replaces `γ`
1717
- `AlphaBetaRule`: arguments `alpha` and `beta` replace `α`, `β`
1818
- ![BREAKING][badge-breaking] Rename `LRP` analyzer keyword argument `is_flat=false` to `flatten=true` ([#119][pr-119])
19-
- ![BREAKING][badge-breaking] Remove `check_model` (replaced by non-exported `check_lrp_compat`) ([#119][pr-119])
19+
- ![BREAKING][badge-breaking] Remove `check_model`, replaced by non-exported `check_lrp_compat` ([#119][pr-119])
2020
- ![BREAKING][badge-breaking] Replace `layerwise_relevances` field of `Explanation` return type by optional named tuple `extras`.
2121
Access layerwise relevances via `extras.layerwise_relevances`. ([#126][pr-126])
2222
- ![BREAKING][badge-breaking] Remove composite `LastNTypeRule` ([#119][pr-119])
@@ -29,8 +29,9 @@ Breaking changes to commonly extended internal functions:
2929
- ![BREAKING][badge-breaking] Pre-allocate modified layers, replacing `modify_param!` with `modify_parameters` ([#102][pr-102])
3030

3131
New features and enhancements:
32-
- ![Feature][badge-feature] Support nested Flux Chains ([#119][pr-119])
33-
- ![Feature][badge-feature] Support `BatchNorm` layers ([#129][pr-129])
32+
- ![Feature][badge-feature] Support nested Flux `Chain`s ([#119][pr-119])
33+
- ![Feature][badge-feature] Support `Parallel` layers ([#135][pr-135], [#138][pr-138])
34+
- ![Feature][badge-feature] Support `BatchNorm` layers ([#129][pr-129], [#134][pr-134])
3435
- ![Feature][badge-feature] Add `GeneralizedGammaRule` ([#109][pr-109])
3536
- ![Feature][badge-feature] Support nested indexing in composite primitive `LayerMap` ([#131][pr-131])
3637
- ![Enhancement][badge-enhancement] Pre-allocate modified layers in `LRP` analyzer field `modified_layers` ([#119][pr-119])
@@ -41,15 +42,22 @@ New features and enhancements:
4142
- ![Enhancement][badge-enhancement] Simplify LRP model checks ([#110][pr-110], [#119][pr-119])
4243
- ![Enhancement][badge-enhancement] Improve type stability of LRP rules
4344

44-
Improvements to documentation:
45-
- ![Documentation][badge-docs] Fix API reference, add diagram explaining LRP layer modification ([#105][pr-105])
46-
- ![Documentation][badge-docs] Fix image loading in README example
45+
Documentation:
46+
- ![Documentation][badge-docs] Update documentation, adding pages on model preparation, composites, custom LRP rules, developer documentation
47+
and a separate API reference for LRP analyzers ([#137][pr-137], [#105][pr-105])
4748

4849
Package maintenance:
4950
- ![Maintenance][badge-maintenance] Refactor LRP rule tests ([#103][pr-103], [#127][pr-127])
5051
- ![Maintenance][badge-maintenance] Fix LRP benchmarks ([#104][pr-104], [#127][pr-127])
5152

5253
### General changes
54+
Breaking changes:
55+
- ![BREAKING][badge-breaking] Rename `Explanation` field `attribution` to `val` ([#136][pr-136])
56+
57+
Documentation:
58+
- ![Documentation][badge-docs] Update documentation, adding pages on heatmapping and input augmentations ([#137][pr-137], [#105][pr-105])
59+
60+
Package maintenance:
5361
- ![Maintenance][badge-maintenance] Compatibility with Flux.jl `v0.14` ([#116][pr-116])
5462
- ![Maintenance][badge-maintenance] Drop dependency on LinearAlgebra.jl and PrettyTables.jl ([#119][pr-119])
5563
- ![Maintenance][badge-maintenance] Add Aqua.jl tests ([#125][pr-125])
@@ -150,7 +158,11 @@ Performance improvements:
150158
![Maintenance][badge-maintenance]
151159
![Documentation][badge-docs]
152160
-->
153-
161+
[pr-138]: https://github.com/adrhill/ExplainableAI.jl/pull/138
162+
[pr-137]: https://github.com/adrhill/ExplainableAI.jl/pull/137
163+
[pr-136]: https://github.com/adrhill/ExplainableAI.jl/pull/136
164+
[pr-135]: https://github.com/adrhill/ExplainableAI.jl/pull/135
165+
[pr-134]: https://github.com/adrhill/ExplainableAI.jl/pull/134
154166
[pr-131]: https://github.com/adrhill/ExplainableAI.jl/pull/131
155167
[pr-130]: https://github.com/adrhill/ExplainableAI.jl/pull/130
156168
[pr-129]: https://github.com/adrhill/ExplainableAI.jl/pull/129

0 commit comments

Comments
 (0)