docs: docstring of least_squares updated.

This commit is contained in:
Fabian Joswig 2023-03-07 16:39:37 +00:00
parent 839d9214ed
commit e6051d7ba0
No known key found for this signature in database

View file

@ -151,7 +151,6 @@ def least_squares(x, y, func, priors=None, silent=False, **kwargs):
For details about how the covariance matrix is estimated see `pyerrors.obs.covariance`.
In practice the correlation matrix is Cholesky decomposed and inverted (instead of the covariance matrix).
This procedure should be numerically more stable as the correlation matrix is typically better conditioned (Jacobi preconditioning).
At the moment this option only works for `prior==None` and when no `method` is given.
expected_chisquare : bool
If True estimates the expected chisquare which is
corrected by effects caused by correlated input data (default False).