Skip to content

Commit 526a5b7

Browse files
committed
Fix LRP rule docstrings
1 parent 367b59b commit 526a5b7

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

src/lrp/rules.jl

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ get_layer_resetter(::ZeroRule, layer) = Returns(nothing)
123123
124124
LRP-``ϵ`` rule. Commonly used on middle layers.
125125
126-
Arguments:
126+
# Arguments:
127127
- `ϵ`: Optional stabilization parameter, defaults to `1f-6`.
128128
129129
# References
@@ -145,7 +145,7 @@ get_layer_resetter(::EpsilonRule, layer) = Returns(nothing)
145145
146146
LRP-``γ`` rule. Commonly used on lower layers.
147147
148-
Arguments:
148+
# Arguments:
149149
- `γ`: Optional multiplier for added positive weights, defaults to `0.25`.
150150
151151
# References
@@ -211,7 +211,7 @@ The parameters `low` and `high` should be set to the lower and upper bounds of t
211211
e.g. `0.0` and `1.0` for raw image data.
212212
It is also possible to provide two arrays of that match the input size.
213213
214-
## References
214+
# References
215215
[1]: G. Montavon et al., Explaining nonlinear classification decisions with deep Taylor decomposition
216216
"""
217217
struct ZBoxRule{T} <: AbstractLRPRule
@@ -255,17 +255,18 @@ end
255255
AlphaBetaRule(alpha, beta)
256256
AlphaBetaRule([alpha=2.0], [beta=1.0])
257257
258-
LRP-``\alpha\beta`` rule. Weights positive and negative contributions according to the
258+
LRP-``\\alpha\\beta`` rule. Weights positive and negative contributions according to the
259259
parameters `alpha` and `beta` respectively. The difference `alpha - beta` must be equal one.
260260
Commonly used on lower layers.
261261
262-
Arguments:
262+
# Arguments:
263263
- `alpha`: Multiplier for the positive output term, defaults to `2.0`.
264264
- `beta`: Multiplier for the negative output term, defaults to `1.0`.
265265
266266
# References
267267
[1]: S. Bach et al., On Pixel-Wise Explanations for Non-Linear Classifier Decisions by
268268
Layer-Wise Relevance Propagation
269+
269270
[2]: G. Montavon et al., Layer-Wise Relevance Propagation: An Overview
270271
"""
271272
struct AlphaBetaRule{T} <: AbstractLRPRule

0 commit comments

Comments
 (0)