jax.experimental.checkify.check

内容

jax.experimental.checkify.check#

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

检查断言，如果断言为 False，则添加一个带有 msg 的错误。

这是一个有副作用的操作，不能被分阶段处理（jitted/scanned/…）。在分阶段处理包含断言的函数之前，请使用 checkify() 处理它!

参数：:

  • pred (Bool) – 如果为 False，则添加一个 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) 注意这些参数可以是跟踪值，允许您将运行时值添加到错误消息中。请注意，跟踪这些运行时数组会增加内存使用量，即使没有发生错误。

返回类型:

无

例如

>>> 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!
目录