jax.experimental.checkify.check

目录

jax.experimental.checkify.check#

jax.experimental.checkify.check(pred, msg, *fmt_args, **fmt_kwargs)[源代码][源代码]#

检查一个谓词，如果谓词为假，则添加一个带有消息的错误。

这是一个有副作用的操作，不能被暂存（jit/扫描/…）。在暂存带有检查的函数之前，请使用 checkify() 进行检查！

参数:

  • pred (Bool) – 如果为假，则添加一个 FailedCheckError 错误。

  • msg (str) – 如果添加错误，则显示错误消息。可以是格式字符串。

  • fmt_args – msg 的位置和关键字格式化参数，例如：check(.., "check failed on values {} and {named_arg}", x, named_arg=y) 请注意，这些参数可以是可追踪的值，允许您在错误消息中添加运行时值。请注意，即使没有发生错误，追踪这些运行时数组也会增加内存使用。

  • fmt_kwargs – msg 的位置和关键字格式化参数，例如：check(.., "check failed on values {} and {named_arg}", x, named_arg=y) 请注意，这些参数可以是可追踪的值，允许您在错误消息中添加运行时值。请注意，即使没有发生错误，追踪这些运行时数组也会增加内存使用。

返回类型:

None

例如：

>>> import jax
>>> import jax.numpy as jnp
>>> from jax.experimental import checkify
>>> def f(x):
...   checkify.check(x>0, "{x} needs to be positive!", x=x)
...   return 1/x
>>> checked_f = checkify.checkify(f)
>>> err, out = jax.jit(checked_f)(-3.)
>>> err.throw()  
Traceback (most recent call last):
  ...
jax._src.checkify.JaxRuntimeError: -3. needs to be positive!
目录