RelevancePropagation v3.0.0

Author: adrhill

CHANGELOG.md

@@ -1,7 +1,13 @@
 # RelevancePropagation.jl
 
+## Version `v3.0.0`
+* ![BREAKING][badge-breaking] Update XAIBase interface to `v4`. 
+  This adds a field to the `Explanation` return type and removes the `add_batch_dim` keyword argument.
+  Refer to the [XAIBase.jl changelog](https://github.com/Julia-XAI/XAIBase.jl/blob/main/CHANGELOG.md#version-v400) for more information ([#19])
+* ![Feature][badge-feature] Add option to skip normalization of output layer relevance ([#22])
+
 ## Version `v2.0.1`
-* ![Bugfix][badge-bugfix] Fix model canonization and flattening on `SkipConnection` and `Parallel` ([#14][pr-14])
+* ![Bugfix][badge-bugfix] Fix model canonization and flattening on `SkipConnection` and `Parallel` ([#14][#14])
 
 ## Version `v2.0.0`
 This release removes the automatic reexport of heatmapping functionality.
@@ -11,24 +17,24 @@ Users are now required to manually load
 This reduces the maintenance burden for new heatmapping features 
 and the amount of dependencies for users who don't require heatmapping functionality.
 
-* ![BREAKING][badge-breaking] Removed reexport of heatmapping functionality by updating XAIBase dependency to `v3.0.0` ([#13][pr-13]).
-* ![Feature][badge-feature] Add support for `LayerNorm` and `Scale` layers ([#9][pr-9])
-* ![Feature][badge-feature] Add `LayerNormRule` ([#9][pr-9])
-* ![Documentation][badge-docs] Add LRP rule overview to docs ([#12][pr-12])
+* ![BREAKING][badge-breaking] Removed reexport of heatmapping functionality by updating XAIBase dependency to `v3.0.0` ([#13][#13]).
+* ![Feature][badge-feature] Add support for `LayerNorm` and `Scale` layers ([#9][#9])
+* ![Feature][badge-feature] Add `LayerNormRule` ([#9][#9])
+* ![Documentation][badge-docs] Add LRP rule overview to docs ([#12][#12])
 
 Some internal improvements were made as well:
-* ![Maintenance][badge-maintenance] update `canonize` mechanism to include model splitting pass `canonize_split` ([#9][pr-9])
-* ![Maintenance][badge-maintenance] improve `modify_layer` by introducing `get_weight` and `get_bias` abstractions to handle varying field names ([#9][pr-9])
-* ![Maintenance][badge-maintenance] Update `LayerMap` to use `ModelIndex` ([#10][pr-10])
-* ![Maintenance][badge-maintenance] Make `chainzip` more robust ([#11][pr-11])
+* ![Maintenance][badge-maintenance] update `canonize` mechanism to include model splitting pass `canonize_split` ([#9][#9])
+* ![Maintenance][badge-maintenance] improve `modify_layer` by introducing `get_weight` and `get_bias` abstractions to handle varying field names ([#9][#9])
+* ![Maintenance][badge-maintenance] Update `LayerMap` to use `ModelIndex` ([#10][#10])
+* ![Maintenance][badge-maintenance] Make `chainzip` more robust ([#11][#11])
 
 ## Version `v1.1.0`
-* ![Feature][badge-feature] Support `SkipConnection` layers ([#8][pr-8])
+* ![Feature][badge-feature] Support `SkipConnection` layers ([#8][#8])
 * ![Documentation][badge-docs] Document LRP rule notation in API reference 
   ([e11c234](https://github.com/Julia-XAI/RelevancePropagation.jl/commit/e11c234c09b7c5232acc5f254379ea5bd01d1e7c))
 
 ## Version `v1.0.1`
-* ![Documentation][badge-docs] Reorganize documentation ([#7][pr-7])
+* ![Documentation][badge-docs] Reorganize documentation ([#7][#7])
 
 ## Version `v1.0.0`
 Initial release of RelevancePropagation.jl.
@@ -45,14 +51,16 @@ Initial release of RelevancePropagation.jl.
 ![Documentation][badge-docs]
 -->
 
-[pr-14]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/14
-[pr-13]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/13
-[pr-12]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/12
-[pr-11]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/11
-[pr-10]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/10
-[pr-9]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/9
-[pr-8]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/8
-[pr-7]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/7
+[#22]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/22
+[#19]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/19
+[#14]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/14
+[#13]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/13
+[#12]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/12
+[#11]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/11
+[#10]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/10
+[#9]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/9
+[#8]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/8
+[#7]: https://github.com/Julia-XAI/RelevancePropagation.jl/pull/7
 
 [VisionHeatmaps]: https://julia-xai.github.io/XAIDocs/VisionHeatmaps/stable/
 [TextHeatmaps]: https://julia-xai.github.io/XAIDocs/TextHeatmaps/stable/

Project.toml

@@ -1,7 +1,7 @@
 name = "RelevancePropagation"
 uuid = "0be6dd02-ae9e-43eb-b318-c6e81d6890d8"
 authors = ["Adrian Hill <[email protected]>"]
-version = "3.0.0-DEV"
+version = "3.0.0"
 
 [deps]
 Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"