rocm_jax/docs/jax.experimental.checkify.rst

``jax.experimental.checkify`` module
====================================


.. automodule:: jax.experimental.checkify

API
---

.. autosummary::
   :toctree: _autosummary

   checkify
   check
   check_error
   Error
   JaxRuntimeError
   user_checks
   nan_checks
   index_checks
   div_checks
   float_checks
   automatic_checks
   all_checks
DOC: make API doc titles more uniform 2023-01-18 10:59:42 -08:00			``jax.experimental.checkify`` module
			`====================================`
Add debugging tools under `jax.debug` and documentation Co-authored-by: Matthew Johnson <mattjj@google.com> Co-authored-by: Lena Martens <lenamartens@google.com> 2022-07-26 14:47:36 -07:00

			`.. automodule:: jax.experimental.checkify`

			`API`
			`---`

			`.. autosummary::`
			`:toctree: _autosummary`

			`checkify`
			`check`
			`check_error`
			`Error`
Rewrite Checkify to support tracking different error types. In general, behavior should remain the same and this is not a breaking change. There are some minor changes to the API: - checkify.ErrorCategory has changed type: it's no longer an Enum, but the JaxException type. These have not been exposed as part of the public API. - some attributes on Error have changed and made private - The raised error has changed type (JaxRuntimeError), and will have a different traceback (pointing to the origin of the error + where the error value was raised). - `checkify.check` now supports formating error message with variable size runtime info! Co-authored-by: Sharad Vikram <sharad.vikram@gmail.com> 2022-10-19 00:53:24 +01:00			`JaxRuntimeError`
Add debugging tools under `jax.debug` and documentation Co-authored-by: Matthew Johnson <mattjj@google.com> Co-authored-by: Lena Martens <lenamartens@google.com> 2022-07-26 14:47:36 -07:00			`user_checks`
			`nan_checks`
			`index_checks`
			`div_checks`
			`float_checks`
			`automatic_checks`
			`all_checks`