jax.custom_vjp.defvjp

custom_vjp.defvjp(fwd, bwd, symbolic_zeros=False, optimize_remat=False)

为此实例表示的函数定义自定义 VJP 规则。

参数:

• fwd (Callable[..., tuple[ReturnValue, Any]]) – 一个 Python 可调用对象，代表自定义 VJP 规则的前向传播。当没有 nondiff_argnums 时，fwd 函数具有与底层原始函数相同的输入签名。它应该返回一个对，其中第一个元素代表原始输出，第二个元素代表为 bwd 函数在后向传播中使用而存储的任何“残差”值。输入参数和输出对的元素可以是数组，也可以是它们的嵌套元组/列表/字典。

• bwd (Callable[..., tuple[Any, ...]]) – 一个 Python 可调用对象，代表自定义 VJP 规则的后向传播。当没有 nondiff_argnums 时，bwd 函数接受两个参数，第一个是 fwd 在前向传播中产生的“残差”值，第二个是与原始函数输出结构相同的输出余切。 bwd 的输出必须是一个长度等于原始函数参数数量的元组，并且元组元素可以是数组，也可以是它们的嵌套元组/列表/字典，以便与原始输入参数的结构匹配。

• symbolic_zeros (bool) –

  布尔值，决定是否向 fwd 和 bwd 规则指示符号零。启用此选项允许自定义导数规则检测某些输入和某些输出余切何时不参与微分。如果 True

  • fwd 必须接受，在原始函数参数组成的 pytree 的每个叶子值 x 的位置，一个具有两个属性的对象（类型为 jax.custom_derivatives.CustomVJPPrimal）：value 和 perturbed。 value 字段是原始的原始参数，而 perturbed 是一个布尔值。 perturbed 位指示该参数是否参与微分（即，如果它为 False，则相应的 Jacobian “列”为零）。

  • bwd 将接收对象来表示其余切参数中的静态符号零，这些对象与未扰动的值相对应；否则，只传递标准的 JAX 类型（例如，数组类）。

  将此选项设置为 True 允许这些规则检测某些输入和输出是否不参与微分，但代价是需要特殊的处理。例如

  • fwd 的签名会改变，并且它接收的对象不能直接从规则输出。

  • bwd 规则接收的对象不完全是数组类，并且无法传递给大多数 jax.numpy 函数。

  • 原始函数参数中涉及的任何自定义 pytree 节点都必须在其解压函数中接受传递给 fwd 规则的输入叶子的两个字段记录对象。

  默认 False。

• optimize_remat (bool) – 布尔值，一个实验性标志，用于在该函数用于 jax.remat() 时启用自动优化。当 fwd 规则是诸如 Pallas 内核或自定义调用之类的抽象调用时，这将非常有用。默认 False。

返回:

无。

返回类型:

无

示例

>>> @jax.custom_vjp
... def f(x, y):
...   return jnp.sin(x) * y
...
>>> def f_fwd(x, y):
...   return f(x, y), (jnp.cos(x), jnp.sin(x), y)
...
>>> def f_bwd(res, g):
...   cos_x, sin_x, y = res
...   return (cos_x * g * y, sin_x * g)
...
>>> f.defvjp(f_fwd, f_bwd)

>>> x = jnp.float32(1.0)
>>> y = jnp.float32(2.0)
>>> with jnp.printoptions(precision=2):
...   print(jax.value_and_grad(f)(x, y))
(Array(1.68, dtype=float32), Array(1.08, dtype=float32))