Skip to content

Commit ba8a2fa

Browse files
yebaigdalle
andauthored
clarify doc for differentiate_with (#767)
* clarify doc for differentiate_with * Update DifferentiationInterface/src/misc/differentiate_with.jl --------- Co-authored-by: Guillaume Dalle <[email protected]>
1 parent ee8c7df commit ba8a2fa

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

DifferentiationInterface/src/misc/differentiate_with.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Moreover, any larger algorithm `alg` that calls `f2` instead of `f` will also be
1313
1414
!!! warning
1515
`DifferentiateWith` only supports out-of-place functions `y = f(x)` without additional context arguments.
16-
It only makes these functions differentiable if the true backend is either [ForwardDiff](https://github.com/JuliaDiff/ForwardDiff.jl) or compatible with [ChainRules](https://github.com/JuliaDiff/ChainRules.jl).
16+
It only makes these functions differentiable if the true backend is either [ForwardDiff](https://github.com/JuliaDiff/ForwardDiff.jl) or automatically importing rules from [ChainRules](https://github.com/JuliaDiff/ChainRules.jl) (e.g. [Zygote](https://github.com/FluxML/Zygote.jl)). Some backends are also able to [manually import rules](https://juliadiff.org/ChainRulesCore.jl/stable/#Packages-supporting-importing-rules-from-ChainRules.) from ChainRules.
1717
For any other true backend, the differentiation behavior is not altered by `DifferentiateWith` (it becomes a transparent wrapper).
1818
1919
# Fields

0 commit comments

Comments
 (0)