From e9d78c529ffc7b0f46fcd42ee85f4ec722620edb Mon Sep 17 00:00:00 2001 From: Avik Pal Date: Sun, 5 Nov 2023 22:15:36 -0500 Subject: [PATCH] Add to docs --- docs/src/api/nonlinearsolve.md | 2 ++ docs/src/solvers/NonlinearLeastSquaresSolvers.md | 12 ++++-------- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/src/api/nonlinearsolve.md b/docs/src/api/nonlinearsolve.md index 5da204f07..3e6009017 100644 --- a/docs/src/api/nonlinearsolve.md +++ b/docs/src/api/nonlinearsolve.md @@ -16,7 +16,9 @@ GeneralKlement ## Polyalgorithms ```@docs +NonlinearSolvePolyAlgorithm FastShortcutNonlinearPolyalg +FastShortcutNLLSPolyalg RobustMultiNewton ``` diff --git a/docs/src/solvers/NonlinearLeastSquaresSolvers.md b/docs/src/solvers/NonlinearLeastSquaresSolvers.md index e414acdd8..1690671d9 100644 --- a/docs/src/solvers/NonlinearLeastSquaresSolvers.md +++ b/docs/src/solvers/NonlinearLeastSquaresSolvers.md @@ -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 @@ -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()) -```