Jaxtyping Versions Save

• Proper documentation! Not just markdown files on GitHub any more. Check out https://docs.kidger.site/jaxtyping.
• Added jaxtyping.{PRNGKeyArray,Scalar,ScalarLike}
• Can now nest, e.g.

  Image = Float[Array, "channels height width"]
  BatchImage = Float[Image, "batch"]
  

• Now packaging in the modern way with pyproject.toml.
• Dtypes can now match regexes (e.g. used in keys to match ^key<\w+>$),

Full Changelog: https://github.com/google/jaxtyping/compare/v0.2.15...v0.2.19

(Yanked; broke the pytest hook. Prefer v0.2.19 instead.)

Full Changelog: https://github.com/google/jaxtyping/compare/v0.2.15...v0.2.18

(Yanked; had incompatibility with non-JAX installations. Prefer v0.2.19 instead.)

Full Changelog: https://github.com/google/jaxtyping/compare/v0.2.15...v0.2.17

(Yanked; had static typing issues. Prefer v0.2.19 instead.)

Full Changelog: https://github.com/google/jaxtyping/compare/v0.2.15...v0.2.16

• Added support for functions in symbolic dimensions, e.g. "min(foo,bar)", which were previously disallowed due to the presence of a comma. (#51)
• Added support for adding ignored names to dimensions, e.g. "cols=4". (#76)
• Added support for Python 3.10 A | B union types (#73)
• Experimental (largely untested) compatibility with torch.compile. (#71)

Full Changelog: https://github.com/google/jaxtyping/compare/v0.2.14...v0.2.15

Highlights

• Silenced spurious pyright>=1.1.293 errors with jaxtyping.PyTree. (Thanks @ZacCranko in #66!)
• Compatibility with Plum v2 (https://github.com/wesselb/plum/pull/73).

Features

• Tweaked install_import_hook(..., typechecker=...) argument to also accept a string. In particular this means it can be used with beartype's new full checking; this can be enabled by passing typechecker="beartype.beartype(conf=beartype.BeartypeConf(strategy=beartype.BeartypeStrategy.On))".
• It is now the case that e.g. issubclass(Float[array_type, ...], array_type). (This is what brings compatibility with Plum v2.)
• NumPy and PyTorch compatibility is now tested.

Bugfixes

• Statements like Bool[int, "..."] should now raise an error.
• Applying @jaxtyping fo functions with fn in their __dict__ should now work.
• Subclassing dataclasses whilst using install_import_hook(..., typechecker="beartype.beartype") should no longer raise a spurious error.
• Changing the value of install_import_hook(..., typechecker=...) will no longer wrongly hit the same __pycache__. (Before this the change in value was ignored.)
• Can now serialise jaxtyping types using cloudpickle.

New Contributors

• @ZacCranko made their first contribution in https://github.com/google/jaxtyping/pull/66

Full Changelog: https://github.com/google/jaxtyping/compare/v0.2.13...v0.2.14

Added support for jax.typing.ArrayLike.

Full Changelog: https://github.com/google/jaxtyping/compare/v0.2.12...v0.2.13

Autogenerated release notes as follows:

What's Changed

• Fix vanilla dataclasses by @brentyi in https://github.com/google/jaxtyping/pull/56
• Fixes for some new failures. (Where did they come from?) by @patrick-kidger in https://github.com/google/jaxtyping/pull/65

Full Changelog: https://github.com/google/jaxtyping/compare/v0.2.11...v0.2.12

Autogenerated release notes as follows:

What's Changed

• Hopefully fixed PyTree raising spurious errors. by @patrick-kidger in https://github.com/google/jaxtyping/pull/54

Full Changelog: https://github.com/google/jaxtyping/compare/v0.2.10...v0.2.11

Autogenerated release notes as follows:

What's Changed

• Fixed working with the new (unreleased) version of typeguard by @patrick-kidger in https://github.com/google/jaxtyping/pull/53

Full Changelog: https://github.com/google/jaxtyping/compare/v0.2.9...v0.2.10