Skip to content

Commit 1725863

Browse files
committed
Fix heatmap docstring
1 parent 53b9f95 commit 1725863

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

src/heatmap.jl

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,25 @@ Visualize explanation.
1717
Assumes the Flux's WHCN convention (width, height, color channels, batch size).
1818
1919
## Keyword arguments
20-
-`cs::ColorScheme`: ColorScheme that is applied.
20+
- `cs::ColorScheme`: ColorScheme that is applied.
2121
When calling `heatmap` with an `Explanation` or analyzer, the method default is selected.
2222
When calling `heatmap` with an array, the default is `ColorSchemes.bwr`.
23-
-`reduce::Symbol`: How the color channels are reduced to a single number to apply a colorscheme.
23+
- `reduce::Symbol`: How the color channels are reduced to a single number to apply a colorscheme.
2424
The following methods can be selected, which are then applied over the color channels
2525
for each "pixel" in the attribution:
2626
- `:sum`: sum up color channels
2727
- `:norm`: compute 2-norm over the color channels
2828
- `:maxabs`: compute `maximum(abs, x)` over the color channels in
2929
When calling `heatmap` with an `Explanation` or analyzer, the method default is selected.
3030
When calling `heatmap` with an array, the default is `:sum`.
31-
-`normalize::Symbol`: How the color channel reduced heatmap is normalized before the colorscheme is applied.
31+
- `normalize::Symbol`: How the color channel reduced heatmap is normalized before the colorscheme is applied.
3232
Can be either `:extrema` or `:centered`.
3333
When calling `heatmap` with an `Explanation` or analyzer, the method default is selected.
3434
When calling `heatmap` with an array, the default for use with the `bwr` colorscheme is `:centered`.
35-
-`permute::Bool`: Whether to flip W&H input channels. Default is `true`.
35+
- `permute::Bool`: Whether to flip W&H input channels. Default is `true`.
3636
3737
**Note:** these keyword arguments can't be used when calling `heatmap` with an analyzer.
3838
"""
39-
4039
function heatmap(
4140
attr::AbstractArray;
4241
cs::ColorScheme=ColorSchemes.bwr,

0 commit comments

Comments
 (0)