patrick-kidger / patrick-kidger/diffrax
How to pass kwargs to `root_find`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 189
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 1
Description
I haven't trawled through the source code but couldn't find this documented. It would be nice to be able to pass kwargs such as max_steps and tags to root_find when doing an implicit solve but not sure how this would work as max_steps coincides with a diffrax kwargs and you would often want very different values for the two.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named. Start by locating the root_find entry point and its documentation, then trace how implicit solves forward kwargs and how diffrax kwargs are separated. Determine whether max_steps and tags are already supported; done means the behavior is documented clearly, with coverage for the conflicting max_steps case if a test location is found.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100