Skip to content

Commit 99113c2

Browse files
committed
Improve backend type docstrings
1 parent cb4eb36 commit 99113c2

File tree

1 file changed

+39
-13
lines changed

1 file changed

+39
-13
lines changed

src/dense.jl

Lines changed: 39 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
"""
22
AutoChainRules{RC}
33
4-
Chooses any AD library based on [ChainRulesCore.jl](https://github.com/JuliaDiff/ChainRulesCore.jl) (see the list [here](https://juliadiff.org/ChainRulesCore.jl/stable/index.html#ChainRules-roll-out-status)).
4+
Type used to select an automatic differentiation backend based on [ChainRulesCore.jl](https://github.com/JuliaDiff/ChainRulesCore.jl) (see the list [here](https://juliadiff.org/ChainRulesCore.jl/stable/index.html#ChainRules-roll-out-status)).
5+
6+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
57
68
# Fields
79
@@ -20,7 +22,9 @@ mode(::AutoChainRules) = ForwardOrReverseMode() # specialized in the extension
2022
"""
2123
AutoDiffractor
2224
23-
Chooses [Diffractor.jl](https://github.com/JuliaDiff/Diffractor.jl).
25+
Type indicating the use of the [Diffractor.jl](https://github.com/JuliaDiff/Diffractor.jl) backend for automatic differentiation.
26+
27+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
2428
2529
# Constructor
2630
@@ -33,7 +37,9 @@ mode(::AutoDiffractor) = ForwardOrReverseMode()
3337
"""
3438
AutoEnzyme{M}
3539
36-
Chooses [Enzyme.jl](https://github.com/EnzymeAD/Enzyme.jl).
40+
Type indicating the use of the [Enzyme.jl](https://github.com/EnzymeAD/Enzyme.jl) backend for automatic differentiation.
41+
42+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
3743
3844
# Fields
3945
@@ -54,7 +60,9 @@ mode(::AutoEnzyme) = ForwardOrReverseMode() # specialized in the extension
5460
"""
5561
AutoFastDifferentiation
5662
57-
Chooses [FastDifferentiation.jl](https://github.com/brianguenter/FastDifferentiation.jl).
63+
Type indicating the use of the [FastDifferentiation.jl](https://github.com/brianguenter/FastDifferentiation.jl) backend for automatic differentiation.
64+
65+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
5866
5967
# Constructor
6068
@@ -67,7 +75,9 @@ mode(::AutoFastDifferentiation) = SymbolicMode()
6775
"""
6876
AutoFiniteDiff{T1,T2,T3}
6977
70-
Chooses [FiniteDiff.jl](https://github.com/JuliaDiff/FiniteDiff.jl).
78+
Type indicating the use of the [FiniteDiff.jl](https://github.com/JuliaDiff/FiniteDiff.jl) backend for automatic differentiation.
79+
80+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
7181
7282
# Fields
7383
@@ -90,7 +100,9 @@ mode(::AutoFiniteDiff) = ForwardMode()
90100
"""
91101
AutoFiniteDifferences{T}
92102
93-
Chooses [FiniteDifferences.jl](https://github.com/JuliaDiff/FiniteDifferences.jl).
103+
Type indicating the use of the [FiniteDifferences.jl](https://github.com/JuliaDiff/FiniteDifferences.jl) backend for automatic differentiation.
104+
105+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
94106
95107
# Fields
96108
@@ -109,7 +121,9 @@ mode(::AutoFiniteDifferences) = ForwardMode()
109121
"""
110122
AutoForwardDiff{chunksize,T}
111123
112-
Chooses [ForwardDiff.jl](https://github.com/JuliaDiff/ForwardDiff.jl).
124+
Type indicating the use of the [ForwardDiff.jl](https://github.com/JuliaDiff/ForwardDiff.jl) backend for automatic differentiation.
125+
126+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
113127
114128
# Type parameters
115129
@@ -136,7 +150,9 @@ mode(::AutoForwardDiff) = ForwardMode()
136150
"""
137151
AutoPolyesterForwardDiff{chunksize,T}
138152
139-
Chooses [PolyesterForwardDiff.jl](https://github.com/JuliaDiff/PolyesterForwardDiff.jl).
153+
Type indicating the use of the [PolyesterForwardDiff.jl](https://github.com/JuliaDiff/PolyesterForwardDiff.jl) backend for automatic differentiation.
154+
155+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
140156
141157
# Type parameters
142158
@@ -163,7 +179,9 @@ mode(::AutoPolyesterForwardDiff) = ForwardMode()
163179
"""
164180
AutoReverseDiff
165181
166-
Chooses [ReverseDiff.jl](https://github.com/JuliaDiff/ReverseDiff.jl).
182+
Type indicating the use of the [ReverseDiff.jl](https://github.com/JuliaDiff/ReverseDiff.jl) backend for automatic differentiation.
183+
184+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
167185
168186
# Fields
169187
@@ -182,7 +200,9 @@ mode(::AutoReverseDiff) = ReverseMode()
182200
"""
183201
AutoSymbolics
184202
185-
Chooses [Symbolics.jl](https://github.com/JuliaSymbolics/Symbolics.jl).
203+
Type indicating the use of the [Symbolics.jl](https://github.com/JuliaSymbolics/Symbolics.jl) backend for automatic differentiation.
204+
205+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
186206
187207
# Constructor
188208
@@ -195,7 +215,9 @@ mode(::AutoSymbolics) = SymbolicMode()
195215
"""
196216
AutoTapir
197217
198-
Chooses [Tapir.jl](https://github.com/withbayes/Tapir.jl).
218+
Type indicating the use of the [Tapir.jl](https://github.com/withbayes/Tapir.jl) backend for automatic differentiation.
219+
220+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
199221
200222
# Constructor
201223
@@ -208,7 +230,9 @@ mode(::AutoTapir) = ReverseMode()
208230
"""
209231
AutoTracker
210232
211-
Chooses [Tracker.jl](https://github.com/FluxML/Tracker.jl).
233+
Type indicating the use of the [Tracker.jl](https://github.com/FluxML/Tracker.jl) backend for automatic differentiation.
234+
235+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
212236
213237
# Constructor
214238
@@ -221,7 +245,9 @@ mode(::AutoTracker) = ReverseMode()
221245
"""
222246
AutoZygote
223247
224-
Chooses [Zygote.jl](https://github.com/FluxML/Zygote.jl).
248+
Type indicating the use of the [Zygote.jl](https://github.com/FluxML/Zygote.jl) backend for automatic differentiation.
249+
250+
Exported by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
225251
226252
# Constructor
227253

0 commit comments

Comments
 (0)