patrick-kidger / patrick-kidger/diffrax
Tidy-up to-dos
Open
Nobody has claimed this yet.
next
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 189
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 1
Description
- jaxtyping
- remove jax.dtypes.canonicalize_dtype
- sympy2jax
- ruff
- private modules
-
import foo as foo - abstract vars (+no more init=False)
- pyproject.toml: no setup.py; no .isort.cfg, no .flake8; use hatchling; no MANIFEST, update release action to v2
- Have
diffrax.RESULTSreturn a wrapper around integers, to prevent comparisons likesol.result == 0 - use
converterand__check_init__instead of__post_init__, e.g. forSubSaveAt. - make sure default arguments don't have conditionals, for the sake of IDE integration
- typing -> collections.abc
- remove
AbstractStepSizeController.wrap_solver. - handle rtol and atol defaults.
- linear and nonlinear solves (including switching to Optx norms)
-
shaped_allclose->tree_equal - ruff-format
- remove
_ad.py -
jrandom->jr - pyright
- switch path's
evaluate(self, t0, t1) -> __call__(self, s0, s1) - Add specific testing flags and check static result + static made jump
- check docs
-
strict=True
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
Review the remaining unchecked items in the checklist, beginning with the path API change from evaluate(self, t0, t1) to call(self, s0, s1), the documentation check, and strict=True. Confirm the relevant project code and docs, then consider the work done when those listed items are resolved and the project checks pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100