Skip to content

Commit d2b33f7

Browse files
committed
DOC: fix x_scale default
1 parent 5fcea08 commit d2b33f7

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

scipy/optimize/_lsq/least_squares.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -387,15 +387,16 @@ def least_squares(
387387
along any of the scaled variables has a similar effect on the cost
388388
function. If set to 'jac', the scale is iteratively updated using the
389389
inverse norms of the columns of the Jacobian matrix (as described in
390-
[JJMore]_). The default scaling for each method is as follows:
390+
[JJMore]_). The default scaling for each method (i.e.
391+
if ``x_scale is None``) is as follows:
391392
392-
* For 'trf' : ``x_scale == 1``
393-
* For 'trf' : ``x_scale == 1``
394-
* For 'jac' : ``x_scale == 'jac'``
393+
* For 'trf' : ``x_scale == 1``
394+
* For 'dogbox' : ``x_scale == 1``
395+
* For 'jac' : ``x_scale == 'jac'``
395396
396397
.. versionchanged:: 1.16.0
397-
The default value is changed from 1 to None to indicate the default
398-
approach to scaling.
398+
The default value is changed from 1 to None to indicate that a
399+
default approach to scaling is used.
399400
For the 'lm' method the default scaling is changed from 1 to 'jac'.
400401
This has been found to give better performance, and is the same
401402
scaling performed by ``leastsq``.

0 commit comments

Comments
 (0)