dynamicslab / pysindy

A package for the sparse identification of nonlinear dynamical systems from data
https://pysindy.readthedocs.io/en/latest/
Other
1.42k stars 310 forks source link

`BaseOptimizer.iters` not documented, needs underscore #379

Open Jacob-Stevens-Haas opened 1 year ago

Jacob-Stevens-Haas commented 1 year ago

Is your feature request related to a problem? Please describe.

self.iters exists, but it

  1. doesn't interact with self.max_iters (at least in STLSQ, the loop keeps two counters)
  2. isn't listen in attributes
  3. should have a trailing underscore to indicate that it is a fit attribute
  4. Is only implemented by SR3, SSR, and STLSQ.

Describe the solution you'd like

Fixing 2 and 3 should be trivial, and 1 shouldn't take much time. For 4, we probably don't really need to make all optimization create this variable, though the base docstring should note this.

Describe alternatives you've considered

Either removal, or creation of a more fully-featured object to keep track of optimization performance.