diff --git a/CHANGELOG.md b/CHANGELOG.md index fcc0547..2ca866d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,23 @@ # RelevancePropagation.jl +## Version `v2.0.0` +This release removes the automatic reexport of heatmapping functionality. +Users are now required to manually load +[VisionHeatmaps.jl][VisionHeatmaps] and/or [TextHeatmaps.jl][TextHeatmaps]. + +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]) + +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]) + ## Version `v1.1.0` * ![Feature][badge-feature] Support `SkipConnection` layers ([#8][pr-8]) * ![Documentation][badge-docs] Document LRP rule notation in API reference @@ -22,9 +41,17 @@ Initial release of RelevancePropagation.jl. ![Documentation][badge-docs] --> +[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 +[VisionHeatmaps]: https://julia-xai.github.io/XAIDocs/VisionHeatmaps/stable/ +[TextHeatmaps]: https://julia-xai.github.io/XAIDocs/TextHeatmaps/stable/ + [badge-breaking]: https://img.shields.io/badge/BREAKING-red.svg [badge-deprecation]: https://img.shields.io/badge/deprecation-orange.svg [badge-feature]: https://img.shields.io/badge/feature-green.svg diff --git a/Project.toml b/Project.toml index f6e10c8..ff61729 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "RelevancePropagation" uuid = "0be6dd02-ae9e-43eb-b318-c6e81d6890d8" authors = ["Adrian Hill "] -version = "2.0.0-DEV" +version = "2.0.0" [deps] Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"