lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-05-14 19:43:41 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: Docstring for fits.least_square extended.

Browse source
This commit is contained in:
Fabian Joswig 2022-05-31 11:51:59 +01:00
parent 52330b7493
commit 4aae55d1d6
2 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.gitignore vendored
View file

@ -6,6 +6,9 @@ __pycache__
.cache .cache
examples/B1k2_pcac_plateau.p examples/B1k2_pcac_plateau.p
examples/Untitled.* examples/Untitled.*
examples/pcac_plateau_test_ensemble.json.gz
core.* core.*
*.swp *.swp
htmlcov htmlcov
build
pyerrors.egg-info

3
pyerrors/fits.py
View file

@ -95,7 +95,8 @@ def least_squares(x, y, func, priors=None, silent=False, **kwargs):
If true all output to the console is omitted (default False). If true all output to the console is omitted (default False).
initial_guess : list initial_guess : list
can provide an initial guess for the input parameters. Relevant for can provide an initial guess for the input parameters. Relevant for
non-linear fits with many parameters. non-linear fits with many parameters. In case of correlated fits the guess is used to perform
an uncorrelated fit which then serves as guess for the correlated fit.
method : str, optional method : str, optional
can be used to choose an alternative method for the minimization of chisquare. can be used to choose an alternative method for the minimization of chisquare.
The possible methods are the ones which can be used for scipy.optimize.minimize and The possible methods are the ones which can be used for scipy.optimize.minimize and