Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the interaction behaviour of @grad and compile. #250

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document the interaction behaviour of @grad and compile. #250

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/macros.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,12 @@ end
xv = ReverseDiff.value(x)
return dot(xv, xv), Δ -> (Δ * 2 * xv,)
end
The `@grad` macro provides a way for the users to define custom adjoints for single-output functions wrt to their input numbers or arrays.
The `@grad` macro provides a way for the users to define custom adjoints for
single-output functions wrt to their input numbers or arrays. The function that
`@grad` is applied to should return a two-element tuple containing the primal
value and the adjoint function. Note that if an adjoint function is compiled
using `compile`, any variables defined outside of the returned adjoint function
are "frozen" at their compiled values.
"""
macro grad(expr)
d = MacroTools.splitdef(expr)
Expand Down
Loading