Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Better documentation of `maxiter` parameter in non-linear fitters

See original GitHub issue

Description

For fitters like LMLSQFitter inheriting from the _NonLinearLSQFitter class, it’d be great if we could improve the documentation to point out the maxiter, acc, and epsilon parameters are exposed when these are called. After some searching through the source code I worked this out, but I couldn’t find any references to this in the documentation. Happy to write something for this but unsure about where in the codebase to write it.

Additional context

Issue Analytics

State:
Created a year ago
Reactions:1
Comments:6 (5 by maintainers)

Top GitHub Comments

1reaction

WilliamJamiesoncommented, Aug 8, 2022

The other fitters define their __call__ methods directly within their classes rather than within the parent class.

1reaction

WilliamJamiesoncommented, Aug 8, 2022

These are documented right here: https://github.com/astropy/astropy/blob/f4615bfafafa4bf75dd4a6b52de1695c1b9f8ea2/astropy/modeling/fitting.py#L1204-L1236

However, it appears the documentation for __call__ from _NonLinearLSQFitter is not being displayed in the astropy docs for LMLSQFitter. Even though it is being displayed for other fitters such as SimplexLSQFitter.

@pllim is there a way to fix the documentation generation to incorporate this?

Top Results From Across the Web

MATLAB lsqnonlin - MathWorks

Nonlinear least-squares solver. ... Find the best-fitting model when some of the fitting parameters have bounds. ... For optimset , the name is...

nls.control: Control the Iterations in nls - Rdrr.io

maxiter. A positive integer specifying the maximum number of iterations allowed. tol. A positive numeric value specifying the tolerance level for the ...

Nonlinear Least-Squares Fitting — GSL 2.7 documentation

This function computes the covariance matrix of best-fit parameters using the Jacobian matrix J and stores it in covar . The parameter epsrel...

Defining New Model Classes — Astropy v1.0.4

This document describes how to add a model to the package or to create a user-defined model. In short, one needs to define...

jaxopt.LevenbergMarquardt — JAXopt 0.5.5 documentation

The parameter which adds a correction to the equation derived for updating the coefficients using Gauss-Newton method. Please see section 3.2. of K....