From 388315c8efd6ccacd8ec83ca476e9158b89e7ee2 Mon Sep 17 00:00:00 2001 From: Sathvik Bhagavan Date: Tue, 9 Jan 2024 12:34:53 +0000 Subject: [PATCH] docs: align a few misaligned code blocks --- docs/src/rule_author/example.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/src/rule_author/example.md b/docs/src/rule_author/example.md index fe81a1b68..d515c9131 100644 --- a/docs/src/rule_author/example.md +++ b/docs/src/rule_author/example.md @@ -58,28 +58,28 @@ Read more about writing rules for constructors and callable objects [here](@ref The `rrule` returns the primal result `y`, and the pullback function. It is a _very_ good idea to name your pullback function, so that they are helpful when appearing in the stacktrace. ```julia - y = foo_mul(foo, b) +y = foo_mul(foo, b) ``` Computes the primal result. It is possible to change the primal computation so that work can be shared between the primal and the pullback. See e.g. [the rule for `sort`](https://github.com/JuliaDiff/ChainRules.jl/blob/a75193768775975fac5578c89d1e5f50d7f358c2/src/rulesets/Base/sort.jl#L19-L35), where the sorting is done only once. ```julia - function foo_mul_pullback(ȳ) - ... - return f̄, f̄oo, b̄ - end +function foo_mul_pullback(ȳ) + ... + return f̄, f̄oo, b̄ +end ``` The pullback function takes in the tangent of the primal output (`ȳ`) and returns the tangents of the primal inputs. Note that it returns a tangent for the primal function in addition to the tangents of primal arguments. Finally, computing the tangents of primal inputs: ```julia - f̄ = NoTangent() +f̄ = NoTangent() ``` The function `foo_mul` has no fields (i.e. it is not a closure) and can not be perturbed. Therefore its tangent (`f̄`) is a `NoTangent`. ```julia - f̄oo = Tangent{Foo}(; A=ȳ * b', c=ZeroTangent()) +f̄oo = Tangent{Foo}(; A=ȳ * b', c=ZeroTangent()) ``` The struct `foo::Foo` gets a `Tangent{Foo}` structural tangent, which stores the tangents of fields of `foo`. @@ -87,7 +87,7 @@ The tangent of the field `A` is `ȳ * b'`, The tangent of the field `c` is `ZeroTangent()`, because `c` can be perturbed but has no effect on the primal output. ```julia - b̄ = @thunk(foo.A' * ȳ) +b̄ = @thunk(foo.A' * ȳ) ``` The tangent of `b` is `foo.A' * ȳ`, but we have wrapped it into a `Thunk`, a tangent type that represents delayed computation. The idea is that in case the tangent is not used anywhere, the computation never happens.