jax.experimental.checkify.check_error

目录

jax.experimental.checkify.check_error#

jax.experimental.checkify.check_error(error)[source]#

如果 error 代表失败，则引发异常。由 checkify() 函数化。

此函数的语义等同于

>>> def check_error(err: Error) -> None:
...   err.throw()  # can raise ValueError

但与该实现不同，check_error 可以使用 checkify() 变换进行函数化。

此函数类似于 check()，但签名不同：check() 以布尔型谓词和新的错误消息字符串作为参数，而此函数以一个 Error 值作为参数。两者都 check() 和此函数在失败时引发 Python 异常（副作用），因此无法通过 jit()、pmap()、scan() 等进行分阶段执行。两者也可以通过使用 checkify() 进行函数化。

但与 check() 不同，此函数类似于 checkify() 的直接逆运算：checkify() 以一个可以引发 Python 异常的函数作为输入，并生成一个没有该副作用的新函数，该函数会生成一个 Error 值作为输出，而此 check_error 函数可以接受一个 Error 值作为输入，并产生引发异常的副作用。也就是说，当 checkify() 从可函数化的异常效果转换为错误值时，此 check_error 从错误值转换为可函数化的异常效果。

check_error 在您想要将由一个 Error 值表示的检查（通过 checkify() 将 checks 函数化而产生）转换为 Python 异常时很有用。

参数:

error (Error) – 要检查的错误。

返回类型:

None

例如，您可能希望通过 checkify 将程序的一部分函数化，通过 jit() 将函数化后的代码分阶段执行，然后在 jit() 之外重新注入错误值。

>>> import jax
>>> from jax.experimental import checkify
>>> def f(x):
...   checkify.check(x>0, "must be positive!")
...   return x
>>> def with_inner_jit(x):
...   checked_f = checkify.checkify(f)
...   # a checkified function can be jitted
...   error, out = jax.jit(checked_f)(x)
...   checkify.check_error(error)
...   return out
>>> _ = with_inner_jit(1)  # no failed check
>>> with_inner_jit(-1)  
Traceback (most recent call last):
  ...
jax._src.JaxRuntimeError: must be positive!
>>> # can re-checkify
>>> error, _ = checkify.checkify(with_inner_jit)(-1)
内容