Use fewer examples with params DataFrame in documentation

optimagic-dev / optimagic

optimagic is a Python package for numerical optimization. It is a unified interface to optimizers from SciPy, NlOpt and other packages. optimagic's minimize function works just like SciPy's, so you don't have to adjust your code. You simply get more optimizers for free. On top you get diagnostic tools, parallel numerical derivatives and more.

https://optimagic.readthedocs.io/

MIT License

270 stars 30 forks source link

Use fewer examples with params DataFrame in documentation #509

Closed janosg closed 3 months ago

janosg commented 4 months ago

Situation

The documentation still contains a few examples with params DataFrames that might mislead users into thinking that some functionality can only be used if a params DataFrame is used. In particular, if they are used together with bounds or soft bounds.

A possible incomplete list of examples is:

how_to_scaling.ipynb
how_to_multistart.ipynb

Task

Replace DataFrame examples by simple numpy arrays
Use om.Bounds to provide bounds.

timmens commented 4 months ago

how_to_scaling.md has been tackled in #508

janosg commented 3 months ago

@timmens isn't the other one also done?

timmens commented 3 months ago

Yes, examples in how-to multistart documentation were updated in #513