Auto-promote more keyword arguments for trust-region algorithms #42
Merged
jessegrabowski merged 2 commits intomainfrom Aug 4, 2025
Merged
Auto-promote more keyword arguments for trust-region algorithms #42jessegrabowski merged 2 commits intomainfrom
jessegrabowski merged 2 commits intomainfrom
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation and auto-promotion of keyword arguments for trust-region minimization algorithms (trust-ncg, trust-krylov, trust-exact) by moving previously undocumented but valid kwargs into the options dictionary for better user accessibility.
- Expands the
valid_optionslists for trust-region algorithms to include previously undocumented parameters - Updates test utilities to handle undocumented SciPy options by maintaining a hardcoded mapping
- Ensures better coverage of available options for users of trust-region optimization methods
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| better_optimize/constants.py | Adds previously undocumented options like "workers", "subproblem_maxiter", "initial_trust_radius", "max_trust_radius", "eta", and "gtol" to the valid_options for trust-region algorithms |
| tests/test_utilities.py | Introduces hardcoded mapping of undocumented options per algorithm and updates assertion logic to account for these missing documentation gaps |
Comments suppressed due to low confidence (1)
tests/test_utilities.py:184
- The error message could be more descriptive. Consider including the method name in the error message: f'Missing options for {method}: {", ".join(missing_options)}'
assert not missing_options, "missing options: " + ", ".join(missing_options)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Several arguments for trust-region minimization algorithms (trust-ncg, trust-krylov, trust-exact) are not documented. This PR moves all valid kwargs into the options dictionary for users.