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

Small changes to documentation #548

Merged
merged 7 commits into from
Nov 12, 2024
Merged

Small changes to documentation #548

merged 7 commits into from
Nov 12, 2024

Conversation

ChristianZimpelmann
Copy link
Member

@ChristianZimpelmann ChristianZimpelmann commented Nov 5, 2024

Fix some typos in documentation and docstrings

Also two more comments/questions:

  • If I am not mistaken, the description of pounders isn't correct. The criterion function seems to be expected as just returning value
 ```{eval-rst}
.. dropdown:: pounders

    .. code-block::

        "pounders"

    Minimize a function using the POUNDERS algorithm.

    POUNDERs (:cite:`Benson2017`, :cite:`Wild2015`, `GitHub repository
    <https://github.com/erdc/petsc4py>`_)
[]
    The criterion function :func:`func` should return a dictionary with the following
    fields:

    1. ``"value"``: The sum of squared (potentially weighted) errors.
    2. ``"root_contributions"``: An array containing the root (weighted) contributions.
    
  • The graph in how_to_algorithm_selection mentions scipy_ls_dogleg, but this algorithm doesn't seem to be supported, yet.

Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines Coverage Δ
src/optimagic/optimizers/_pounders/gqtpar.py 90.54% <ø> (ø)
...timagic/optimizers/_pounders/pounders_auxiliary.py 97.32% <ø> (ø)
src/optimagic/optimizers/pounders.py 92.56% <ø> (ø)

... and 1 file with indirect coverage changes

@janosg
Copy link
Member

janosg commented Nov 5, 2024

Thanks, I'll have a look at your comments. The description of the pounders objective function is definitely outdated. I'll check about scipy_ls_dogleg.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@janosg
Copy link
Member

janosg commented Nov 12, 2024

The correct name of the algorithm is scipy_ls_dogbox because it is a dogleg algorithm with support for box constraints. I adjusted the decision tree.

Copy link
Member

@janosg janosg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for the PR!

@janosg janosg merged commit 52c6774 into main Nov 12, 2024
17 checks passed
@janosg janosg deleted the docs branch November 12, 2024 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants