Skip to content

Commit 134e36e

Browse files
committed
Optim.md: SemOptimizerOptim => SemOptiimizer
1 parent c190504 commit 134e36e

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/src/tutorials/backends/optim.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
# Using Optim.jl
22

3-
[`SemOptimizerOptim`](@ref) implements the connection to `Optim.jl`.
4-
It takes two arguments, `algorithm` and `options`.
5-
The defaults are LBFGS as the optimization algorithm and the standard options from `Optim.jl`.
6-
We can load the `Optim` and `LineSearches` packages to choose something different:
3+
[Optim.jl](https://github.com/JuliaNLSolvers/Optim.jl) is the default optimization engine of *SEM.jl*,
4+
see [`SemOptimizerOptim`](@ref) for a full list of its parameters.
5+
It defaults to the LBFGS optimization, but we can load the `Optim` and `LineSearches` packages
6+
and specify BFGS (!not L-BFGS) with a back-tracking linesearch and Hager-Zhang initial step length guess:
77

88
```julia
99
using Optim, LineSearches
1010

11-
my_optimizer = SemOptimizerOptim(
11+
my_optimizer = SemOptimizer(
1212
algorithm = BFGS(
13-
linesearch = BackTracking(order=3),
13+
linesearch = BackTracking(order=3),
1414
alphaguess = InitialHagerZhang()
15-
),
16-
options = Optim.Options(show_trace = true)
17-
)
15+
),
16+
options = Optim.Options(show_trace = true)
17+
)
1818
```
1919

20-
This optimizer will use BFGS (!not L-BFGS) with a back tracking linesearch and a certain initial step length guess. Also, the trace of the optimization will be printed to the console.
20+
Note that we used `options` to print the optimization progress to the console.
2121

2222
To see how to use the optimizer to actually fit a model now, check out the [Model fitting](@ref) section.
2323

0 commit comments

Comments
 (0)