Skip to content

Commit

Permalink
Add to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
avik-pal committed Nov 6, 2023
1 parent 44ccbb6 commit be6d69e
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 9 deletions.
2 changes: 2 additions & 0 deletions docs/src/api/nonlinearsolve.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ GeneralKlement
## Polyalgorithms

```@docs
NonlinearSolvePolyAlgorithm
FastShortcutNonlinearPolyalg
FastShortcutNLLSPolyalg
RobustMultiNewton
```

Expand Down
12 changes: 4 additions & 8 deletions docs/src/solvers/NonlinearLeastSquaresSolvers.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ Solves the nonlinear least squares problem defined by `prob` using the algorithm

## Recommended Methods

`LevenbergMarquardt` is a good choice for most problems.
The default method `FastShortcutNLLSPolyalg` is a good choice for most
problems. It is a polyalgorithm that attempts to use a fast algorithm
(`GaussNewton`) and if that fails it falls back to a more robust
algorithm (`LevenbergMarquardt`).

## Full List of Methods

Expand All @@ -21,10 +24,3 @@ Solves the nonlinear least squares problem defined by `prob` using the algorithm
problems.
- `SimpleNewtonRaphson()`: Simple Gauss Newton Implementation with `QRFactorization` to
solve a linear least squares problem at each step!

## Example usage

```julia
using NonlinearSolve
sol = solve(prob, LevenbergMarquardt())
```
2 changes: 1 addition & 1 deletion test/23_test_problems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ end
alg_ops = (GeneralBroyden(; max_resets = 10),)

broken_tests = Dict(alg => Int[] for alg in alg_ops)
broken_tests[alg_ops[1]] = [1, 2, 4, 5, 6, 11, 12, 13, 14, 22]
broken_tests[alg_ops[1]] = [1, 2, 4, 5, 6, 11, 12, 13, 14]

test_on_library(problems, dicts, alg_ops, broken_tests)
end
Expand Down

0 comments on commit be6d69e

Please sign in to comment.