Chex

Chex is a library of utilities for helping to write reliable JAX code.

This includes utils to help:

• Instrument your code (e.g. assertions)

• Debug (e.g. transforming pmaps in vmaps within a context manager).

• Test JAX code across many variants (e.g. jitted vs non-jitted).

Modules overview can be found on GitHub.

Installation

Chex can be installed with pip directly from github, with the following command:

pip install git+git://github.com/deepmind/chex.git

or from PyPI:

pip install chex

API Documentation

• Assertions
  • Jax Assertions
  • Value (Runtime) Assertions
  • Tree Assertions
  • Generic Assertions
  • Shapes and Named Dimensions
  • Utils
• Warnings
  • create_deprecated_function_alias()
  • warn_deprecated_function()
  • warn_keyword_args_only_in_future()
  • warn_only_n_pos_args_in_future()
• Backend restriction
  • restrict_backends()
• Dataclasses
  • dataclass()
  • mappable_dataclass()
  • register_dataclass_type_with_jax_tree_util()
• Fakes
  • Transformations
  • Devices
• Pytypes
• Variants
  • ChexVariantType
  • TestCase
  • variants()
  • all_variants()
  • params_product()

Citing Chex

This repository is part of the DeepMind JAX Ecosystem.

To cite Chex please use the DeepMind JAX Ecosystem citation.

Contribute

• Issue tracker

• Source code

Support

If you are having issues, please let us know by filing an issue on our issue tracker.

License

Chex is licensed under the Apache 2.0 License.

Indices and Tables

• Index