jax.experimental.checkify.checkify#

jax.experimental.checkify.checkify(f, errors=frozenset({<class 'jax._src.checkify.FailedCheckError'>}))[源代码]#

函数化 fun 中的 check 调用，并可选地添加运行时错误检查。

运行时错误可以是用户添加的 check() 断言，也可以是自动添加的检查（如 NaN 检查），具体取决于 errors 参数。

返回的函数将返回一个 Error 对象 err 以及原始函数的输出。 err.get() 将返回 None（如果没有发生错误）或包含错误消息的字符串。此错误消息将对应于发生的第一个错误。如果发生错误，err.throw() 将引发一个带有错误消息的 ValueError。

默认情况下，只启用用户添加的 check() 断言。您可以通过 errors 参数启用自动检查。

可启用的自动检查集以及何时生成错误

  • user_checks：一个 check() 被评估为 False。

  • nan_checks：浮点运算生成 NaN 值作为输出。

  • div_checks：除以零。

  • index_checks：索引越界。

可以通过传递一个 Error Set（例如 errors=nan_checks）来启用多个类别。多个集合可以重新组合（例如 errors=float_checks|user_checks）。

参数:

  • fun – 可以包含用户检查的可调用对象（参见 check()）。

  • errors (frozenset[ErrorCategory]) – 定义启用检查集的 ErrorCategory 值集合。默认情况下，只启用显式的 checks （user_checks）。例如，您也可以通过传递 float_checks 集合来启用 NAN 和 DIV 错误，或者例如通过集合操作（float_checks | user_checks）组合多个集合。

  • f (Callable[..., Out])

返回:

一个函数，它接受与 fun 相同的参数，并返回一个对，其中第一个元素是 Error 值，表示第一个失败的 check()，第二个元素是 fun 的原始输出。

返回类型:

Callable[…, tuple[Error, Out]]

例如

>>> import jax
>>> import jax.numpy as jnp
>>> from jax.experimental import checkify
>>>
>>> @jax.jit
... def f(x):
...   y = jnp.sin(x)
...   return x+y
>>> err, out = checkify.checkify(f, errors=checkify.float_checks)(jnp.inf)
>>> err.throw()  
Traceback (most recent call last):
  ...
jax._src.checkify.JaxRuntimeError: nan generated by primitive: sin