Skip to content

Commit f5a82bd

Browse files
committed
Document new type parameter for AutoReverseDiff
1 parent d41670e commit f5a82bd

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/dense.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ function Base.show(io::IO, backend::AutoPolyesterForwardDiff{chunksize}) where {
219219
end
220220

221221
"""
222-
AutoReverseDiff
222+
AutoReverseDiff{compile}
223223
224224
Struct used to select the [ReverseDiff.jl](https://github.com/JuliaDiff/ReverseDiff.jl) backend for automatic differentiation.
225225
@@ -231,7 +231,7 @@ Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
231231
232232
# Fields
233233
234-
- `compile::Union{Val, Bool}`: whether to [compile the tape](https://juliadiff.org/ReverseDiff.jl/api/#ReverseDiff.compile) prior to differentiation
234+
- `compile::Union{Val, Bool}`: whether to [compile the tape](https://juliadiff.org/ReverseDiff.jl/api/#ReverseDiff.compile) prior to differentiation (the boolean version is also the type parameter)
235235
"""
236236
struct AutoReverseDiff{C} <: AbstractADType
237237
compile::Bool # this field is left for legacy reasons

0 commit comments

Comments
 (0)