Skip to content

Commit 97ffd68

Browse files
committed
Add deets to AutoMooncake
1 parent 02a0606 commit 97ffd68

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

src/dense.jl

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,10 +276,16 @@ end
276276
"""
277277
AutoMooncake
278278
279-
Struct used to select the [Mooncake.jl](https://github.com/compintell/Mooncake.jl) backend for automatic differentiation.
279+
Struct used to select the [Mooncake.jl](https://github.com/compintell/Mooncake.jl) backend for automatic differentiation in reverse mode.
280280
281281
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
282282
283+
!!! info
284+
285+
When forward mode became available in Mooncake.jl v0.4.147, another struct called [`AutoMooncakeForward`](@ref) was introduced.
286+
It was kept separate to avoid a breaking release of ADTypes.jl.
287+
[`AutoMooncake`](@ref) remains for reverse mode only.
288+
283289
# Constructors
284290
285291
AutoMooncake(; config=nothing)
@@ -303,7 +309,9 @@ Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
303309
304310
!!! info
305311
306-
This type was introduced when forward mode became available in Mooncake.jl v0.4.147. It was kept separate from [`AutoMooncake`](@ref) in order to avoid requiring a breaking release of ADTypes.jl.
312+
This struct was introduced when forward mode became available in Mooncake.jl v0.4.147.
313+
It was kept separate from [`AutoMooncake`](@ref) to avoid a breaking release of ADTypes.jl.
314+
[`AutoMooncake`](@ref) remains for reverse mode only.
307315
308316
# Constructors
309317

0 commit comments

Comments
 (0)