Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 0.5.0 [WIP] #501

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Release 0.5.0 [WIP] #501

wants to merge 12 commits into from

Conversation

janosg
Copy link
Member

@janosg janosg commented Jul 10, 2024

Release 0.5.0 will bring several breaking changes and deprecations. On a high level, the major changes are:

  • Implement EP-02: Static typing
  • Implement EP-03: Alignment with SciPy
  • Rename the package from estimagic to optimagic (while keeping the estimagic
    namespace for the estimation capabilities).

This branch will stay open until all changes are implemented. The actual changes are implemented as PRs on this branch. In the end we will merge this PR without squashing commits.

We roughly have the following things to do:

Renaming

  • Rename and restructure the package
  • Rename and restructure the documentation
  • Add infrastructure to release under two names

Alignment

  • Align the argument names of minimize and maximize with scipy
  • Introduce aliases
  • Rename algo-options
  • Align step-size of numerical derivatives during optimization
  • Make issue for further alignment that does not involve deprecations (e.g. hess, hessp, ...)
  • Add a default algorithm

Typing

  • Implement new objective function interface
  • Implement new bounds interface
  • Implement new constraints interface
  • Implement new internal algorithm interface
  • Implement unfiltered algorithm selection and make issue for filtered algorithm selection
  • Implement new algo-options interfaces
  • Implement new interface for custom derivatives
  • Implement jax autodiff
  • Implement new logging
  • Implement new scaling interface
  • Implement new multistart interface
  • Improve numerical differentiation
  • Replace other option dictionaries by option objects
  • Implement new benchmarking interface and architecture
  • Make adjustments for estimation functions

Documentation

  • Write a completely new docstring for minimize and maximize (I deleted the old one instead of making mini updates all the time)
  • Go over all code snippets and notebooks in the documentation and make sure they use recommended interfaces

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@janosg janosg added the WIP Work in progress label Jul 10, 2024
Copy link

codecov bot commented Jul 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.35%. Comparing base (2ab9ac5) to head (cbbdd61).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #501      +/-   ##
==========================================
- Coverage   93.08%   90.35%   -2.74%     
==========================================
  Files         195      102      -93     
  Lines       14718     9493    -5225     
==========================================
- Hits        13700     8577    -5123     
+ Misses       1018      916     -102     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
WIP Work in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants