Skip to content

Commit 0033827

Browse files
authored
Remove heatmapping docs (#182)
1 parent a5e05d9 commit 0033827

File tree

5 files changed

+16
-173
lines changed

5 files changed

+16
-173
lines changed

docs/Project.toml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,3 @@ Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
1212
MLDatasets = "eb30cadb-4394-5ae3-aed4-317e484a6458"
1313
VisionHeatmaps = "27106da1-f8bc-4ca8-8c66-9b8289f1e035"
1414
Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
15-
16-
[compat]
17-
VisionHeatmaps = "1.4"

docs/make.jl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ makedocs(;
3535
"Home" => "index.md",
3636
"Getting started" => "generated/example.md",
3737
"General usage" => Any[
38-
"Heatmapping" => "generated/heatmapping.md",
3938
"Input augmentations" => "generated/augmentations.md",
4039
],
4140
"API Reference" => "api.md",

docs/src/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ julia> ]add ExplainableAI
2121
```@contents
2222
Pages = [
2323
"generated/example.md",
24-
"generated/heatmapping.md",
2524
"generated/augmentations.md",
2625
]
2726
Depth = 3

docs/src/literate/example.jl

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,6 @@ heatmap(expl)
8181
# into a single function call:
8282
heatmap(input, analyzer)
8383

84-
# For a more detailed explanation of the `heatmap` function,
85-
# refer to the [heatmapping section](@ref docs-heatmapping).
86-
87-
# ## [List of analyzers](@id docs-analyzers-list)
88-
8984
# ## Neuron selection
9085
# By passing an additional index to our call to [`analyze`](@ref),
9186
# we can compute an explanation with respect to a specific output neuron.
@@ -114,5 +109,19 @@ expl = analyze(batch, analyzer);
114109
# Calling `heatmap` on `expl` will detect the batch dimension and return a vector of heatmaps.
115110
heatmap(expl)
116111

117-
# For more information on heatmapping batches,
118-
# refer to the [heatmapping documentation](@ref docs-heatmapping-batches).
112+
## Custom heatmaps
113+
114+
# The function `heatmap` automatically applies common presets for each method.
115+
#
116+
# Since [`InputTimesGradient`](@ref) computes attributions,
117+
# heatmaps are shown in a blue-white-red color scheme.
118+
# Gradient methods however are typically shown in grayscale:
119+
analyzer = Gradient(model)
120+
heatmap(input, analyzer)
121+
#-
122+
analyzer = InputTimesGradient(model)
123+
heatmap(input, analyzer)
124+
125+
# Using [VisionHeatmaps.jl](https://julia-xai.github.io/XAIDocs/VisionHeatmaps/stable/),
126+
# heatmaps can be heavily customized.
127+
# Check out the [heatmapping documentation](https://julia-xai.github.io/XAIDocs/VisionHeatmaps/stable/) for more information.

docs/src/literate/heatmapping.jl

Lines changed: 0 additions & 161 deletions
This file was deleted.

0 commit comments

Comments
 (0)