Skip to content

Commit

Permalink
ExplainableAI v0.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@adrhill
adrhill committed Jan 30, 2024
1 parent 54d9b12 commit 75954c8
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,19 @@
# ExplainableAI.jl
## Version `v0.7.0`
This release moves the core interface (`Explanation`, `heatmap`, `analyze`)
into a separate package called [XAIBase.jl](https://github.com/Julia-XAI/XAIBase.jl).
Developers can make use of the [XAIBase.jl interface](https://julia-xai.github.io/XAIDocs/XAIBase/)
to quickly implement or prototype new methods without having to write boilerplate code.

As announced with version `v0.6.2`, this is first release without LRP, which has been moved to a separate package called [RelevancePropagation.jl](https://github.com/Julia-XAI/RelevancePropagation.jl). This separation is enabled by the new common XAIBase.jl interface.

- ![BREAKING][badge-breaking] Move core interface into XAIBase.jl package ([#154][pr-154]).
- Renamed `Explanation` field `neuron_selection` to `output_selection`
- Added `Explanation` field `heatmap` for heatmapping presets
- ![BREAKING][badge-breaking] Move LRP into RelevancePropagation.jl ([#157][pr-157])
- ![BREAKING][badge-breaking] Remove ImageNet preprocessing utilities ([#159][pr-159])
- ![Documentation][badge-docs] Partially move documentation into the [Julia-XAI ecosystem documentation](https://github.com/Julia-XAI/XAIDocs)

## Version `v0.6.3`
- ![Enhancement][badge-enhancement] Allow Gradient analyzers on non-Flux models ([#150][pr-150])
- ![Bugfix][badge-bugfix] Fix typo in `BATCHDIM_MISSING` error ([#150][pr-150])
Expand Down Expand Up @@ -180,6 +195,9 @@ Performance improvements:
![Maintenance][badge-maintenance]
![Documentation][badge-docs]
-->
[pr-159]: https://github.com/Julia-XAI/ExplainableAI.jl/pull/159
[pr-157]: https://github.com/Julia-XAI/ExplainableAI.jl/pull/157
[pr-154]: https://github.com/Julia-XAI/ExplainableAI.jl/pull/154
[pr-150]: https://github.com/Julia-XAI/ExplainableAI.jl/pull/150
[pr-149]: https://github.com/Julia-XAI/ExplainableAI.jl/pull/149
[pr-148]: https://github.com/Julia-XAI/ExplainableAI.jl/pull/148
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ExplainableAI"
uuid = "4f1bc3e1-d60d-4ed0-9367-9bdff9846d3b"
authors = ["Adrian Hill <[email protected]>"]
version = "1.0.0-DEV"
version = "0.7.0"

[deps]
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
Expand Down

4 comments on commit 75954c8

@adrhill
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/99883

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.7.0 -m "<description of version>" 75954c8d5fdaf022605ccbe7b31b413efc78a769
git push origin v0.7.0

@adrhill
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

This release moves the core interface (Explanation, heatmap, analyze) into a separate package called XAIBase.jl. Developers can make use of the XAIBase.jl interface to quickly implement or prototype new methods without having to write boilerplate code.

As announced with version v0.6.2, this is first release without LRP, which has been moved to a separate package called RelevancePropagation.jl. This separation is enabled by the new common XAIBase.jl interface.

Notable changes

  • BREAKING Move core interface into XAIBase.jl package (#154).
    • Renamed Explanation field neuron_selection to output_selection
    • Added Explanation field heatmap for heatmapping presets
  • BREAKING Move LRP into RelevancePropagation.jl (#157)
  • BREAKING Remove ImageNet preprocessing utilities (#159)
  • Documentation Partially move documentation into the Julia-XAI ecosystem documentation

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/99883

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.7.0 -m "<description of version>" 75954c8d5fdaf022605ccbe7b31b413efc78a769
git push origin v0.7.0

Please sign in to comment.