Skip to content

Commit dd1632f

Browse files
AdityaPandeyCNChrisRackauckas
authored andcommitted
added docs for the changes
Signed-off-by: AdityaPandeyCN <[email protected]>
1 parent 4911fbd commit dd1632f

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/src/solvers/nonlinear_least_squares_solvers.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,15 @@ Submethod choices for this algorithm include:
7979
- `:lmdif`: Advanced Levenberg-Marquardt
8080
- `:hybrd`: Advanced modified version of Powell's algorithm
8181

82+
### SciPy (Python via PythonCall)
83+
84+
A wrapper over `scipy.optimize.least_squares`. Requires that the Python
85+
package `scipy` is available to PythonCall.
86+
87+
- [`SciPyLeastSquares()`](@ref) with convenience constructors
88+
`SciPyLeastSquaresTRF()`, `SciPyLeastSquaresDogbox()`, and
89+
`SciPyLeastSquaresLM()` for the common method choices.
90+
8291
### Optimization.jl
8392

8493
`NonlinearLeastSquaresProblem`s can be converted into an `OptimizationProblem` and used

docs/src/solvers/nonlinear_system_solvers.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,3 +186,13 @@ This is a wrapper package for importing solvers from PETSc.jl into the SciML int
186186
[PETSc.jl](https://github.com/JuliaParallel/PETSc.jl)
187187

188188
For a list of possible solvers see the [PETSc.jl documentation](https://petsc.org/release/manual/snes/)
189+
190+
### SciPy (Python via PythonCall)
191+
192+
These wrappers let you use the algorithms from
193+
[`scipy.optimize`](https://docs.scipy.org/doc/scipy/reference/optimize.html)
194+
without leaving Julia. SciPy is loaded lazily through PythonCall, so these
195+
methods are available whenever the `scipy` Python package can be imported.
196+
197+
- [`SciPyRoot()`](@ref): wrapper for `scipy.optimize.root` (vector problems)
198+
- [`SciPyRootScalar()`](@ref): wrapper for `scipy.optimize.root_scalar` (scalar/bracketed problems)

0 commit comments

Comments
 (0)