Result dataclasses - Githubissues

ICB-DCM / pyPESTO

python Parameter EStimation TOolbox

https://pypesto.readthedocs.io

BSD 3-Clause "New" or "Revised" License

211 stars 47 forks source link

Result dataclasses #814

Open dilpath opened 2 years ago

dilpath commented 2 years ago

Feature description Result objects refactored to be dataclasses [1]. e.g. OptimizerResult [2] already looks like a dataclass.

Motivation/Application

simpler code in pyPESTO
benefits of dataclasses
- transform combined results into other useful types (e.g. pd.DataFrame(list_of_dataclass))
- automatic __repr__ and __eq__ (though may need to be customized in pyPESTO)

Issues

backwards-compatibility
- deprecation warnings and temporary methods for compatibility could be used.

[1] https://docs.python.org/3/library/dataclasses.html [2] https://github.com/ICB-DCM/pyPESTO/blob/a4ce1d219774b265b9825eca827e7e18d57f37ef/pypesto/result/optimize.py#L66-L105

jvanhoefer commented 2 years ago

:+1: Nice idea!