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.

Sign up for GitHub

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

Doc: IpoptOptimizer #1543

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Doc: IpoptOptimizer #1543

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions pypesto/optimize/optimizer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ def get_default_options(self):


class IpoptOptimizer(Optimizer):
"""Use IpOpt (https://pypi.org/project/ipopt/) for optimization."""
"""Use Ipopt (https://pypi.org/project/cyipopt/) for optimization."""

def __init__(self, options: dict = None):
"""
Expand All @@ -560,6 +560,9 @@ def __init__(self, options: dict = None):
options:
Options are directly passed on to `cyipopt.minimize_ipopt`, except
for the `approx_grad` option, which is handled separately.

For a list of available options, see the Ipopt documentation
(https://coin-or.github.io/Ipopt/OPTIONS.html).
"""
super().__init__()
self.approx_grad = False
Expand Down Expand Up @@ -599,7 +602,7 @@ def minimize(
jac = objective.get_grad
else:
raise ValueError(
"For IPOPT, the objective must either be able to return "
"For Ipopt, the objective must either be able to return "
"gradients or the `approx_grad` must be set to True."
)

Expand Down
Loading