Skip to content

Fix UnboundLocalError when stopping_criterion=None in convergence_plot #659

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

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

Fix UnboundLocalError when stopping_criterion=None in convergence_plot #659

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59fb50f
Fix stopping_criterion=None handling in convergence_plot
szd5654125 Dec 16, 2025
e030be6
Following maintainer feedback on PR #659, clarify that stopping_crite…
szd5654125 Dec 19, 2025
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: 4 additions & 3 deletions src/optimagic/visualization/convergence_plot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def convergence_plot(
runtime_measure: Literal[
"n_evaluations", "walltime", "n_batches"
] = "n_evaluations",
stopping_criterion: Literal["x", "y", "x_and_y", "x_or_y"] | None = "y",
stopping_criterion: Literal["x", "y", "x_and_y", "x_or_y"] = "y",
x_precision: float = 1e-4,
y_precision: float = 1e-4,
combine_plots_in_grid: bool = True,
Expand Down Expand Up @@ -118,8 +118,9 @@ def convergence_plot(
the solution value.
runtime_measure: This is the runtime until the desired convergence was reached
by an algorithm.
stopping_criterion: Determines how convergence is determined from the two
precisions. If None, no convergence criterion is applied.
stopping_criterion: Determines how convergence is determined from the two precisions.
To effectively disable convergence, set `x_precision` and/or `y_precision`
to very small values (or 0).
x_precision: how close an algorithm must have gotten to the true parameter
values (as percent of the Euclidean distance between start and solution
parameters) before the criterion for clipping and convergence is fulfilled.
Expand Down
Loading