Skip to content

Commit

Permalink
Last polishing.
Browse files Browse the repository at this point in the history
  • Loading branch information
janosg committed Jul 10, 2024
1 parent cd80345 commit 2ff9966
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/source/development/eep-03-alignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ from estimagic import minimize
| `convergence_relative_gradient_tolerance` | `convergence_gtol_rel` | NlOpt |
| `convergence_scaled_gradient_tolerance` | `convergence_gtol_scaled` | |

While it seems that many names are taken from NlOpt and not from SciPy, this is a bit
misleading. SciPy does use the words `xtol`, `ftol` and `gtol` just like NlOpt, but it
does not completely harmonize them between algorithms. We therefore chose NlOpt's
version which is understandable for everyone who knows SciPy but more readable than
SciPy's.

## Names we do not want to align

- We do not want to rename `algorithm` to `method` because our algorithm names are
Expand Down Expand Up @@ -95,7 +101,7 @@ relevant:
- If a user sets `jac=True` we raise and error and explain how to use `fun_and_jac`
instead.

## Aligning default values
## Letting algorithms pick their default values

Currently we try to align default values for convergence criteria and other algorithm
options across algorithms and even across optimizer packages. This means that sometimes
Expand Down

0 comments on commit 2ff9966

Please sign in to comment.