diff options
| author | Mike Jarvis <michael@jarvis.net> | 2021-06-08 07:41:59 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-08 14:41:59 +0300 |
| commit | 5c4aac16b54284a59bc5af34e731be7299cbb1d1 (patch) | |
| tree | e3310251db564f44e9b18e77402955c6a2c4632e /numpy/array_api/_creation_functions.py | |
| parent | 8f1eff4d9b09741d1e989e8118d67af4de7990c5 (diff) | |
| download | numpy-5c4aac16b54284a59bc5af34e731be7299cbb1d1.tar.gz | |
DOC: Adjust polyfit doc to clarify the meaning of w (#18421)
* DOC: Adjust polyfit doc to clarify the meaning of w
cov='unscaled', in particular, had inconsistently referred to a weight
of 1/sigma**2, while the doc for w says it should be equal to 1/sigma.
This change clarifies w to comport with more typical meanings of
weights in weighted least squares, and makes clear that cov='unscaled'
is appropriate when the weight w**2 = 1/sigma**2.
See Issue #5261 for more discussion of the errors/confusion in
the previous doc string.
* Update doc text for w in all polynomial module fit functions
Co-authored-by: Stefan van der Walt <sjvdwalt@gmail.com>
Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
Diffstat (limited to 'numpy/array_api/_creation_functions.py')
0 files changed, 0 insertions, 0 deletions