File tree Expand file tree Collapse file tree 4 files changed +36
-27
lines changed Expand file tree Collapse file tree 4 files changed +36
-27
lines changed Original file line number Diff line number Diff line change
1
+ # [ Automatic Differentiation Construction Choice Recommendations] ( ad )
2
+
3
+ The choices for the auto-AD fill-ins with quick descriptions are:
4
+
5
+ - ` AutoForwardDiff() ` : The fastest choice for small optimizations
6
+ - ` AutoReverseDiff(compile=false) ` : A fast choice for large scalar optimizations
7
+ - ` AutoTracker() ` : Like ReverseDiff but GPU-compatible
8
+ - ` AutoZygote() ` : The fastest choice for non-mutating array-based (BLAS) functions
9
+ - ` AutoFiniteDiff() ` : Finite differencing, not optimal but always applicable
10
+ - ` AutoModelingToolkit() ` : The fastest choice for large scalar optimizations
11
+ - ` AutoEnzyme() ` : Highly performant AD choice for type stable and optimized code
12
+
13
+ ## Automatic Differentiation Choice API
14
+
15
+ The following sections describe the Auto-AD choices in detail.
16
+
17
+ ``` @docs
18
+ Optimization.AutoForwardDiff
19
+ Optimization.AutoFiniteDiff
20
+ Optimization.AutoReverseDiff
21
+ Optimization.AutoZygote
22
+ Optimization.AutoTracker
23
+ Optimization.AutoModelingToolkit
24
+ Optimization.AutoEnzyme
25
+ ```
Original file line number Diff line number Diff line change 2
2
3
3
``` @docs
4
4
SciMLBase.OptimizationFunction
5
- ```
6
-
7
- ## Automatic Differentiation Construction Choice Recommendations
8
-
9
- The choices for the auto-AD fill-ins with quick descriptions are:
10
-
11
- - ` AutoForwardDiff() ` : The fastest choice for small optimizations
12
- - ` AutoReverseDiff(compile=false) ` : A fast choice for large scalar optimizations
13
- - ` AutoTracker() ` : Like ReverseDiff but GPU-compatible
14
- - ` AutoZygote() ` : The fastest choice for non-mutating array-based (BLAS) functions
15
- - ` AutoFiniteDiff() ` : Finite differencing, not optimal but always applicable
16
- - ` AutoModelingToolkit() ` : The fastest choice for large scalar optimizations
17
- - ` AutoEnzyme() ` : Highly performant AD choice for type stable and optimized code
18
-
19
- ## Automatic Differentiation Choice API
20
-
21
- The following sections describe the Auto-AD choices in detail.
22
-
23
- ``` @docs
24
- Optimization.AutoForwardDiff
25
- Optimization.AutoFiniteDiff
26
- Optimization.AutoReverseDiff
27
- Optimization.AutoZygote
28
- Optimization.AutoTracker
29
- Optimization.AutoModelingToolkit
30
- Optimization.AutoEnzyme
31
- ```
5
+ ```
Original file line number Diff line number Diff line change
1
+ # [ OptimizationState] (@id optstate)
2
+
3
+ ``` @docs
4
+ Optimization.OptimizationState
5
+ ```
Original file line number Diff line number Diff line change
1
+ # [ OptimizationStats] (@id optstats)
2
+
3
+ ``` @docs
4
+ SciMLBase.OptimizationStats
5
+ ```
You can’t perform that action at this time.
0 commit comments