Add `NumdiffResult` object

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

Add `NumdiffResult` object #514

Closed timmens closed 3 months ago

timmens commented 4 months ago

[x] Update pre-commit hooks and add numpy to pre-commit mypy environment
[x] Add NumdiffResult object
[x] Add type hints to the first and second derivative outer interface
[x] Deprecate Richardson extrapolation options as well as return_func_value argument
[x] Test deprecations
[x] Update documentation

review-notebook-app[bot] commented 4 months ago

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 98.93617% with 1 line in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/optimagic/differentiation/derivatives.py	98.38%	1 Missing :warning:

Files with missing lines	Coverage Δ
src/optimagic/deprecations.py	`100.00% <100.00%> (ø)`
src/optimagic/optimization/optimize_result.py	`93.98% <100.00%> (ø)`
src/optimagic/differentiation/derivatives.py	`98.05% <98.38%> (ø)`