Add note about SimpleNewtonRaphson

SciML · Oct 9, 2023 · f46984a · f46984a
1 parent b25eb74
commit f46984a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/src/solvers/NonlinearLeastSquaresSolvers.md b/docs/src/solvers/NonlinearLeastSquaresSolvers.md
@@ -19,6 +19,10 @@ Solves the nonlinear least squares problem defined by `prob` using the algorithm
     handling of sparse matrices via colored automatic differentiation and preconditioned
     linear solvers. Designed for large-scale and numerically-difficult nonlinear least squares
     problems.
+  - `SimpleNewtonRaphson()`: Newton Raphson implementation that uses Linear Least Squares
+    solution at every step to compute the descent direction. **WARNING**: This method is not
+    a robust solver for nonlinear least squares problems. The computed delta step might not
+    be the correct descent direction!
 
 ## Example usage