-
-
Notifications
You must be signed in to change notification settings - Fork 167
Add an informative error message if the solver has not been instantiated #706
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
Open
johannahaffner
wants to merge
1
commit into
patrick-kidger:dev
Choose a base branch
from
johannahaffner:uninstantiated-solver-error
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1084,6 +1084,22 @@ def _promote(yi): | |
| y0 = jtu.tree_map(_promote, y0) | ||
| del timelikes | ||
|
|
||
| # Check if the solver is an instance of AbstractSolver and provide an informative | ||
| # error if it is not. Addresses https://github.com/patrick-kidger/diffrax/issues/705 | ||
| if not isinstance(solver, AbstractSolver): | ||
| if issubclass(solver, AbstractSolver): | ||
| msg = ( | ||
| "It looks like you forgot to instantiate your solver, e.g. by passing " | ||
| "`dfx.Euler` instead of `dfx.Euler()`." | ||
|
Owner
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The |
||
| ) | ||
| raise ValueError(msg) | ||
| else: | ||
| msg = ( | ||
| "Argument `solver` must be an instance of (some subclass of) " | ||
| "`dfx.AbstractSolver`, but its type is not recognised." | ||
| ) | ||
| raise ValueError(msg) | ||
|
|
||
| # Backward compatibility | ||
| if isinstance(solver, (EulerHeun, ItoMilstein, StratonovichMilstein)): | ||
| try: | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will error out if
solveris not a class. We needisinstance(solver, type) and issubclass(solver, AbstractSolver).