acerbilab / pybads

PyBADS: Bayesian Adaptive Direct Search optimization algorithm for model fitting in Python
https://acerbilab.github.io/pybads/
BSD 3-Clause "New" or "Revised" License
69 stars 2 forks source link

SciPy-style OptimizeResult #45

Closed jungtaekkim closed 1 year ago

jungtaekkim commented 1 year ago

I think that you wanted to follow the style of the SciPy's OptimizeResult.

If needed, you can mention that it is a similar feature of the OptimizeResult in SciPy.

It will help users understand how they would use this feature.

https://github.com/acerbilab/pybads/blob/1bee482a7b53526aa3acc177c10707c28490b7ea/pybads/bads/optimize_result.py#L8

GurjeetSinghSangra commented 1 year ago

Ok thank you for your feedback, I just added the reference in the code as part of the documentation of the class.