针对 JAX 可变换 Python 函数的自定义导数规则

JAX 可变换 Python 函数的自定义导数规则#

在 JAX 中定义微分规则有两种方式：

使用 jax.custom_jvp 和 jax.custom_vjp 为已能进行 JAX 变换的 Python 函数定义自定义微分规则；以及
定义新的 core.Primitive 实例及其所有变换规则，例如用于调用来自其他系统（如求解器、模拟器或通用数值计算系统）的函数。

本笔记本主要讨论第 #1 点。若要阅读关于第 #2 点的内容，请参阅关于 JAX 原语（primitives）工作原理的笔记本。

有关 JAX 自动微分 API 的介绍，请参阅自动微分实战指南 (Autodiff Cookbook)。本笔记本假设读者熟悉 jax.jvp 和 jax.grad，以及 JVP 和 VJP 的数学含义。

TL;DR：使用 `jax.custom_jvp` 定义自定义 JVP#

import jax.numpy as jnp
from jax import custom_jvp

@custom_jvp
def f(x, y):
  return jnp.sin(x) * y

@f.defjvp
def f_jvp(primals, tangents):
  x, y = primals
  x_dot, y_dot = tangents
  primal_out = f(x, y)
  tangent_out = jnp.cos(x) * x_dot * y + jnp.sin(x) * y_dot
  return primal_out, tangent_out

from jax import jvp, grad

print(f(2., 3.))
y, y_dot = jvp(f, (2., 3.), (1., 0.))
print(y)
print(y_dot)
print(grad(f)(2., 3.))

# Equivalent alternative using the defjvps convenience wrapper

@custom_jvp
def f(x, y):
  return jnp.sin(x) * y

f.defjvps(lambda x_dot, primal_out, x, y: jnp.cos(x) * x_dot * y,
          lambda y_dot, primal_out, x, y: jnp.sin(x) * y_dot)

print(f(2., 3.))
y, y_dot = jvp(f, (2., 3.), (1., 0.))
print(y)
print(y_dot)
print(grad(f)(2., 3.))

TL;DR：使用 `jax.custom_vjp` 定义自定义 VJP#

from jax import custom_vjp

@custom_vjp
def f(x, y):
  return jnp.sin(x) * y

def f_fwd(x, y):
  # Returns primal output and residuals to be used in backward pass by f_bwd.
  return f(x, y), (jnp.cos(x), jnp.sin(x), y)

def f_bwd(res, g):
  cos_x, sin_x, y = res # Gets residuals computed in f_fwd
  return (cos_x * g * y, sin_x * g)

f.defvjp(f_fwd, f_bwd)

print(grad(f)(2., 3.))

-1.2484405

示例问题#

为了了解 jax.custom_jvp 和 jax.custom_vjp 旨在解决哪些问题，我们先看几个示例。下一节将更详细地介绍 jax.custom_jvp 和 jax.custom_vjp API。

示例：数值稳定性#

jax.custom_jvp 的一个应用是提高微分的数值稳定性。

假设我们要编写一个名为 log1pexp 的函数，计算 \(x \mapsto \log ( 1 + e^x )\)。我们可以使用 jax.numpy 编写它

def log1pexp(x):
  return jnp.log(1. + jnp.exp(x))

log1pexp(3.)

Array(3.0485873, dtype=float32, weak_type=True)

由于它是用 jax.numpy 编写的，因此它是 JAX 可变换的

from jax import jit, grad, vmap

print(jit(log1pexp)(3.))
print(jit(grad(log1pexp))(3.))
print(vmap(jit(grad(log1pexp)))(jnp.arange(3.)))

3.0485873
0.95257413
[0.5       0.7310586 0.8807971]

但这里隐藏着一个数值稳定性问题

print(grad(log1pexp)(100.))

nan

这看起来不对！毕竟，\(x \mapsto \log (1 + e^x)\) 的导数是 \(x \mapsto \frac{e^x}{1 + e^x}\)，因此对于较大的 \(x\) 值，我们预期结果应接近 1。

通过查看梯度计算的 jaxpr，我们可以更深入地了解发生了什么

from jax import make_jaxpr

make_jaxpr(grad(log1pexp))(100.)

{ lambda ; a:f32[]. let
    b:f32[] = exp a
    c:f32[] = add 1.0:f32[] b
    _:f32[] = log c
    d:f32[] = div 1.0:f32[] c
    e:f32[] = mul d b
  in (e,) }

逐步执行 jaxpr 的计算过程，我们可以看到最后一行涉及将浮点数计算结果舍入为 0 和 \(\infty\) 的值进行相乘，这通常不是好主意。也就是说，我们实际上是在对较大的 x 执行 lambda x: (1 / (1 + jnp.exp(x))) * jnp.exp(x)，这有效地变成了 0. * jnp.inf。

与其生成这些极值并指望浮点数无法保证的抵消，我们宁愿将导数函数表达为更数值稳定的程序。特别是，我们可以编写一个更贴近等价数学表达式 \(1 - \frac{1}{1 + e^x}\) 的程序，其中不存在抵消问题。

这个问题很有意思，因为即使我们对 log1pexp 的定义已经可以进行 JAX 微分（并使用 jit、vmap 等进行变换），我们依然对将标准自动微分规则应用于构成 log1pexp 的原语并组合结果后的表现不满意。相反，我们希望作为一个整体来指定 log1pexp 函数应如何微分，从而更好地处理这些指数项。

这是 Python 函数自定义导数规则的一个应用，即在为其他变换（如 jit、vmap 等）保留原始 Python 定义的同时，指定复合函数应如何微分。

这是一个使用 jax.custom_jvp 的解决方案

from jax import custom_jvp

@custom_jvp
def log1pexp(x):
  return jnp.log(1. + jnp.exp(x))

@log1pexp.defjvp
def log1pexp_jvp(primals, tangents):
  x, = primals
  x_dot, = tangents
  ans = log1pexp(x)
  ans_dot = (1 - 1/(1 + jnp.exp(x))) * x_dot
  return ans, ans_dot

print(grad(log1pexp)(100.))

1.0

print(jit(log1pexp)(3.))
print(jit(grad(log1pexp))(3.))
print(vmap(jit(grad(log1pexp)))(jnp.arange(3.)))

3.0485873
0.95257413
[0.5       0.7310586 0.8807971]

这是使用 defjvps 便利包装器来表达同样内容的示例

@custom_jvp
def log1pexp(x):
  return jnp.log(1. + jnp.exp(x))

log1pexp.defjvps(lambda t, ans, x: (1 - 1/(1 + jnp.exp(x))) * t)

print(grad(log1pexp)(100.))
print(jit(log1pexp)(3.))
print(jit(grad(log1pexp))(3.))
print(vmap(jit(grad(log1pexp)))(jnp.arange(3.)))

0
0485873
95257413
[0.5       0.7310586 0.8807971]

示例：强制执行微分约定#

一个相关的应用是在边界处强制执行微分约定。

考虑函数 \(f : \mathbb{R}_+ \to \mathbb{R}_+\)，其中 \(f(x) = \frac{x}{1 + \sqrt{x}}\)，此处 \(\mathbb{R}_+ = [0, \infty)\)。我们可能会这样实现 \(f\)

def f(x):
  return x / (1 + jnp.sqrt(x))

作为 \(\mathbb{R}\)（整个实数轴）上的数学函数，\(f\) 在 0 处是不可微的（因为定义导数的极限从左侧不存在）。相应地，自动微分产生了一个 nan 值

print(grad(f)(0.))

nan

但从数学上讲，如果我们认为 \(f\) 是 \(\mathbb{R}_+\) 上的函数，那么它在 0 处是可微的 [Rudin 的《数学分析原理》定义 5.1，或 Tao 的《分析学 I》第 3 版定义 10.1.1 和示例 10.1.6]。或者，我们可以约定我们想要考虑从右侧的定向导数。因此，Python 函数 grad(f) 在 0.0 处返回一个合理的值，即 1.0。默认情况下，JAX 的微分机制假定所有函数都在 \(\mathbb{R}\) 上定义，因此此处不会产生 1.0。

我们可以使用自定义 JVP 规则！特别是，我们可以根据 \(\mathbb{R}_+\) 上的导数函数 \(x \mapsto \frac{\sqrt{x} + 2}{2(\sqrt{x} + 1)^2}\) 来定义 JVP 规则，

@custom_jvp
def f(x):
  return x / (1 + jnp.sqrt(x))

@f.defjvp
def f_jvp(primals, tangents):
  x, = primals
  x_dot, = tangents
  ans = f(x)
  ans_dot = ((jnp.sqrt(x) + 2) / (2 * (jnp.sqrt(x) + 1)**2)) * x_dot
  return ans, ans_dot

print(grad(f)(0.))

1.0

这是使用便利包装器的版本

@custom_jvp
def f(x):
  return x / (1 + jnp.sqrt(x))

f.defjvps(lambda t, ans, x: ((jnp.sqrt(x) + 2) / (2 * (jnp.sqrt(x) + 1)**2)) * t)

print(grad(f)(0.))

1.0

示例：梯度裁剪#

虽然在某些情况下我们想要表达数学上的微分计算，但在其他情况下，我们甚至可能希望偏离数学，调整自动微分执行的计算。一个典型的例子是反向模式梯度裁剪。

对于梯度裁剪，我们可以将 jnp.clip 与 jax.custom_vjp 的仅限反向模式规则结合使用

from functools import partial
from jax import custom_vjp

@custom_vjp
def clip_gradient(lo, hi, x):
  return x  # identity function

def clip_gradient_fwd(lo, hi, x):
  return x, (lo, hi)  # save bounds as residuals

def clip_gradient_bwd(res, g):
  lo, hi = res
  return (None, None, jnp.clip(g, lo, hi))  # use None to indicate zero cotangents for lo and hi

clip_gradient.defvjp(clip_gradient_fwd, clip_gradient_bwd)

import matplotlib.pyplot as plt
from jax import vmap

t = jnp.linspace(0, 10, 1000)

plt.plot(jnp.sin(t))
plt.plot(vmap(grad(jnp.sin))(t))

[<matplotlib.lines.Line2D at 0x7c21c2ee87a0>]

../_images/2ad99fdae85bc336f05f5fafa60c376f2ce74f77194bbc31986f6135ab113b0d.png

def clip_sin(x):
  x = clip_gradient(-0.75, 0.75, x)
  return jnp.sin(x)

plt.plot(clip_sin(t))
plt.plot(vmap(grad(clip_sin))(t))

[<matplotlib.lines.Line2D at 0x7c21c30ba390>]

../_images/c9560918ad667fbe11349e59dd9b672b0246e85e7c9d7d30d704ac131899c486.png

示例：Python 调试#

另一个出于开发工作流而非数值考虑的应用，是在反向模式自动微分的后向传播（backward pass）中设置 pdb 调试器跟踪。

在试图追踪 nan 运行时错误的根源，或仅仅想仔细检查被传播的余切（梯度）值时，在后向传播中插入一个对应于原函数计算中特定点的调试器是很有用的。你可以使用 jax.custom_vjp 来做到这一点。

我们将把示例推迟到下一节。

示例：迭代实现的隐函数微分#

这个示例深入探讨了数学细节！

jax.custom_vjp 的另一个应用是反向模式微分，适用于那些可进行 JAX 变换（通过 jit、vmap 等）但由于某些原因无法高效进行 JAX 微分的函数，例如涉及 lax.while_loop 的函数。（无法生成能高效计算 XLA HLO while_loop 反向模式导数的 XLA HLO 程序，因为这需要无限内存使用的程序，而这在 XLA HLO 中无法表达，至少在没有通过 infeed/outfeed 进行副作用交互的情况下是如此。）

例如，考虑这个 fixed_point 程序，它通过在 while_loop 中迭代应用函数来计算不动点

from jax.lax import while_loop

def fixed_point(f, a, x_guess):
  def cond_fun(carry):
    x_prev, x = carry
    return jnp.abs(x_prev - x) > 1e-6

  def body_fun(carry):
    _, x = carry
    return x, f(a, x)

  _, x_star = while_loop(cond_fun, body_fun, (x_guess, f(a, x_guess)))
  return x_star

这是一种迭代程序，用于数值求解方程 \(x = f(a, x)\) 中的 \(x\)，通过迭代 \(x_{t+1} = f(a, x_t)\) 直到 \(x_{t+1}\) 足够接近 \(x_t\)。结果 \(x^*\) 取决于参数 \(a\)，因此我们可以认为存在一个由方程 \(x = f(a, x)\) 隐式定义的函数 \(a \mapsto x^*(a)\)。

我们可以使用 fixed_point 来运行迭代程序直到收敛，例如运行牛顿法来计算平方根，同时只执行加法、乘法和除法

def newton_sqrt(a):
  update = lambda a, x: 0.5 * (x + a / x)
  return fixed_point(update, a, a)

print(newton_sqrt(2.))

1.4142135

我们也可以对该函数使用 vmap 或 jit

print(jit(vmap(newton_sqrt))(jnp.array([1., 2., 3., 4.])))

[1.        1.4142135 1.7320509 2.       ]

由于 while_loop 的存在，我们无法应用反向模式自动微分。但事实证明，即使可以，我们也不想这么做：与其通过 fixed_point 的实现及其所有迭代进行微分，我们不如利用数学结构来做一些更节省内存（且本例中更节省浮点运算）的事情！我们可以利用隐函数定理 [Bertsekas《非线性规划》第 2 版，附录 A.25]，它（在一定条件下）保证了我们即将使用的数学对象的存在。本质上，我们在解处进行线性化，并迭代求解这些线性方程以计算我们想要的导数。

再次考虑方程 \(x = f(a, x)\) 和函数 \(x^*\)。我们想要计算向量-雅可比积，如 \(v^\mathsf{T} \mapsto v^\mathsf{T} \partial x^*(a_0)\)。

至少在我们想要微分的点 \(a_0\) 周围的一个开邻域内，假设对于所有 \(a\)，方程 \(x^*(a) = f(a, x^*(a))\) 都成立。由于等式两边作为 \(a\) 的函数是相等的，它们的导数也必须相等，所以让我们对两边进行微分

\(\qquad \partial x^*(a) = \partial_0 f(a, x^*(a)) + \partial_1 f(a, x^*(a)) \partial x^*(a)\).

设置 \(A = \partial_1 f(a_0, x^*(a_0))\) 和 \(B = \partial_0 f(a_0, x^*(a_0))\)，我们可以将所求量简单地写为

\(\qquad \partial x^*(a_0) = B + A \partial x^*(a_0)\),

或者通过重排：

\(\qquad \partial x^*(a_0) = (I - A)^{-1} B\).

这意味着我们可以计算向量-雅可比积，例如

\(\qquad v^\mathsf{T} \partial x^*(a_0) = v^\mathsf{T} (I - A)^{-1} B = w^\mathsf{T} B\),

其中 \(w^\mathsf{T} = v^\mathsf{T} (I - A)^{-1}\)，等价于 \(w^\mathsf{T} = v^\mathsf{T} + w^\mathsf{T} A\)，或者等价于 \(w^\mathsf{T}\) 是映射 \(u^\mathsf{T} \mapsto v^\mathsf{T} + u^\mathsf{T} A\) 的不动点。最后这个表征为我们提供了一种以调用 fixed_point 的形式来编写 fixed_point VJP 的方法！此外，在将 \(A\) 和 \(B\) 展开后，我们可以看到我们只需要在 \((a_0, x^*(a_0))\) 处评估 \(f\) 的 VJP。

总结如下

from jax import vjp

@partial(custom_vjp, nondiff_argnums=(0,))
def fixed_point(f, a, x_guess):
  def cond_fun(carry):
    x_prev, x = carry
    return jnp.abs(x_prev - x) > 1e-6

  def body_fun(carry):
    _, x = carry
    return x, f(a, x)

  _, x_star = while_loop(cond_fun, body_fun, (x_guess, f(a, x_guess)))
  return x_star

def fixed_point_fwd(f, a, x_init):
  x_star = fixed_point(f, a, x_init)
  return x_star, (a, x_star)

def fixed_point_rev(f, res, x_star_bar):
  a, x_star = res
  _, vjp_a = vjp(lambda a: f(a, x_star), a)
  a_bar, = vjp_a(fixed_point(partial(rev_iter, f),
                             (a, x_star, x_star_bar),
                             x_star_bar))
  return a_bar, jnp.zeros_like(x_star)

def rev_iter(f, packed, u):
  a, x_star, x_star_bar = packed
  _, vjp_x = vjp(lambda x: f(a, x), x_star)
  return x_star_bar + vjp_x(u)[0]

fixed_point.defvjp(fixed_point_fwd, fixed_point_rev)

print(newton_sqrt(2.))

1.4142135

print(grad(newton_sqrt)(2.))
print(grad(grad(newton_sqrt))(2.))

0.35355338
-0.088388346

我们可以通过对 jnp.sqrt 进行微分来检查我们的答案，它使用了完全不同的实现

print(grad(jnp.sqrt)(2.))
print(grad(grad(jnp.sqrt))(2.))

0.35355338
-0.08838835

这种方法的一个局限是参数 f 不能闭包引用（close over）微分过程中涉及的任何值。也就是说，你可能注意到我们在 fixed_point 的参数列表中明确保留了参数 a。对于此用例，请考虑使用低级原语 lax.custom_root，它允许在具有自定义求根函数的闭包变量中进行导数计算。

`jax.custom_jvp` 和 `jax.custom_vjp` API 的基本用法#

使用 `jax.custom_jvp` 定义前向模式（以及间接定义反向模式）规则#

这是使用 jax.custom_jvp 的典型基本示例，其中注释使用了类似 Haskell 的类型签名

from jax import custom_jvp
import jax.numpy as jnp

# f :: a -> b
@custom_jvp
def f(x):
  return jnp.sin(x)

# f_jvp :: (a, T a) -> (b, T b)
def f_jvp(primals, tangents):
  x, = primals
  t, = tangents
  return f(x), jnp.cos(x) * t

f.defjvp(f_jvp)

<function __main__.f_jvp(primals, tangents)>

from jax import jvp

print(f(3.))

y, y_dot = jvp(f, (3.,), (1.,))
print(y)
print(y_dot)

0.14112
0.14112
-0.9899925

简而言之，我们从一个原始函数 f 开始，它接受类型为 a 的输入并产生类型为 b 的输出。我们为其关联一个 JVP 规则函数 f_jvp，它接受一对输入，分别代表类型为 a 的原始输入和类型为 T a 的对应切线（tangent）输入，并产生一对输出，分别代表类型为 b 的原始输出和类型为 T b 的切线输出。切线输出应该是切线输入的线性函数。

你也可以使用 f.defjvp 作为装饰器，如下所示

@custom_jvp
def f(x):
  ...

@f.defjvp
def f_jvp(primals, tangents):
  ...

尽管我们只定义了 JVP 规则而没有定义 VJP 规则，但我们可以对 f 同时使用前向和反向模式微分。JAX 会自动转置自定义 JVP 规则对切线值执行的线性计算，从而计算 VJP，效率与手动编写规则一样高

from jax import grad

print(grad(f)(3.))
print(grad(grad(f))(3.))

-0.9899925
-0.14112

要使自动转置起作用，JVP 规则的输出切线必须是输入切线的线性函数。否则会引发转置错误。

多个参数的工作方式如下

@custom_jvp
def f(x, y):
  return x ** 2 * y

@f.defjvp
def f_jvp(primals, tangents):
  x, y = primals
  x_dot, y_dot = tangents
  primal_out = f(x, y)
  tangent_out = 2 * x * y * x_dot + x ** 2 * y_dot
  return primal_out, tangent_out

print(grad(f)(2., 3.))

12.0

defjvps 便利包装器允许我们分别定义每个参数的 JVP，结果会分别计算并求和

@custom_jvp
def f(x):
  return jnp.sin(x)

f.defjvps(lambda t, ans, x: jnp.cos(x) * t)

print(grad(f)(3.))

-0.9899925

这是一个带有多个参数的 defjvps 示例

@custom_jvp
def f(x, y):
  return x ** 2 * y

f.defjvps(lambda x_dot, primal_out, x, y: 2 * x * y * x_dot,
          lambda y_dot, primal_out, x, y: x ** 2 * y_dot)

print(grad(f)(2., 3.))
print(grad(f, 0)(2., 3.))  # same as above
print(grad(f, 1)(2., 3.))

0
0
0

作为简写，使用 defjvps 时，你可以传递 None 值来表示某个特定参数的 JVP 为零

@custom_jvp
def f(x, y):
  return x ** 2 * y

f.defjvps(lambda x_dot, primal_out, x, y: 2 * x * y * x_dot,
          None)

print(grad(f)(2., 3.))
print(grad(f, 0)(2., 3.))  # same as above
print(grad(f, 1)(2., 3.))

0
0
0

使用关键字参数调用 jax.custom_jvp 函数，或编写带有默认参数的 jax.custom_jvp 函数定义，都是允许的，只要它们能够根据标准库 inspect.signature 机制检索到的函数签名明确映射到位置参数即可。

当你未执行微分时，函数 f 的调用方式与未被 jax.custom_jvp 装饰时完全一样

@custom_jvp
def f(x):
  print('called f!')  # a harmless side-effect
  return jnp.sin(x)

@f.defjvp
def f_jvp(primals, tangents):
  print('called f_jvp!')  # a harmless side-effect
  x, = primals
  t, = tangents
  return f(x), jnp.cos(x) * t

from jax import vmap, jit

print(f(3.))

called f!
0.14112

print(vmap(f)(jnp.arange(3.)))
print(jit(f)(3.))

called f!
[0.         0.84147096 0.9092974 ]
called f!
0.14112

自定义 JVP 规则在微分过程中（无论是前向还是反向）被调用

y, y_dot = jvp(f, (3.,), (1.,))
print(y_dot)

called f_jvp!
called f!
-0.9899925

print(grad(f)(3.))

called f_jvp!
called f!
-0.9899925

请注意，f_jvp 调用 f 来计算原始输出。在更高阶微分的上下文中，每次微分变换的应用只有在规则调用原始 f 来计算原始输出时，才会使用自定义 JVP 规则。（这代表了一种基本的权衡，我们无法在我们的规则中利用 f 计算的中间值，同时又让该规则适用于所有阶数的高阶微分。）

grad(grad(f))(3.)

called f_jvp!
called f_jvp!
called f!

Array(-0.14112, dtype=float32, weak_type=True)

你可以将 Python 控制流与 jax.custom_jvp 一起使用

@custom_jvp
def f(x):
  if x > 0:
    return jnp.sin(x)
  else:
    return jnp.cos(x)

@f.defjvp
def f_jvp(primals, tangents):
  x, = primals
  x_dot, = tangents
  ans = f(x)
  if x > 0:
    return ans, 2 * x_dot
  else:
    return ans, 3 * x_dot

print(grad(f)(1.))
print(grad(f)(-1.))

2.0
3.0

使用 `jax.custom_vjp` 定义仅限反向模式的自定义规则#

虽然 jax.custom_jvp 足以通过 JAX 的自动转置来控制前向和反向模式的微分行为，但在某些情况下，我们可能希望直接控制 VJP 规则，例如在上面提到的后两个示例问题中。我们可以使用 jax.custom_vjp 来实现

from jax import custom_vjp
import jax.numpy as jnp

# f :: a -> b
@custom_vjp
def f(x):
  return jnp.sin(x)

# f_fwd :: a -> (b, c)
def f_fwd(x):
  return f(x), jnp.cos(x)

# f_bwd :: (c, CT b) -> CT a
def f_bwd(cos_x, y_bar):
  return (cos_x * y_bar,)

f.defvjp(f_fwd, f_bwd)

from jax import grad

print(f(3.))
print(grad(f)(3.))

0.14112
-0.9899925

简而言之，我们同样从一个原始函数 f 开始，它接受类型为 a 的输入并产生类型为 b 的输出。我们为其关联两个函数 f_fwd 和 f_bwd，它们分别描述如何执行反向模式自动微分的前向传播和后向传播。

函数 f_fwd 描述前向传播，不仅包括原始计算，还包括保存哪些值以供后向传播使用。其输入签名与原始函数 f 完全一样，接受类型为 a 的原始输入。但输出是一个元组对，其中第一个元素是原始输出 b，第二个元素是存储以供后向传播使用的类型为 c 的任何“残差”数据。（这第二个输出类似于 PyTorch 的 save_for_backward 机制。）

函数 f_bwd 描述后向传播。它接受两个输入，第一个是 f_fwd 产生的类型为 c 的残差数据，第二个是对应原始函数输出的类型为 CT b 的输出余切。它产生一个类型为 CT a 的输出，代表对应原始函数输入的余切。特别是，f_bwd 的输出必须是一个序列（例如元组），其长度等于原始函数的参数数量。

所以多个参数的工作方式如下

from jax import custom_vjp

@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)

print(grad(f)(2., 3.))

-1.2484405

使用关键字参数调用 jax.custom_vjp 函数，或编写带有默认参数的 jax.custom_vjp 函数定义，都是允许的，只要它们能够根据标准库 inspect.signature 机制检索到的函数签名明确映射到位置参数即可。

与 jax.custom_jvp 一样，如果未应用微分，则不调用由 f_fwd 和 f_bwd 组成的自定义 VJP 规则。如果函数被执行，或通过 jit、vmap 或其他非微分变换进行变换，则只调用 f。

@custom_vjp
def f(x):
  print("called f!")
  return jnp.sin(x)

def f_fwd(x):
  print("called f_fwd!")
  return f(x), jnp.cos(x)

def f_bwd(cos_x, y_bar):
  print("called f_bwd!")
  return (cos_x * y_bar,)

f.defvjp(f_fwd, f_bwd)

print(f(3.))

called f!
0.14112

print(grad(f)(3.))

called f_fwd!
called f!
called f_bwd!
-0.9899925

y, f_vjp = vjp(f, 3.)
print(y)

called f_fwd!
called f!
0.14112

print(f_vjp(1.))

called f_bwd!
(Array(-0.9899925, dtype=float32, weak_type=True),)

不能对 jax.custom_vjp 函数使用前向模式自动微分，否则会引发错误

from jax import jvp

try:
  jvp(f, (3.,), (1.,))
except TypeError as e:
  print('ERROR! {}'.format(e))

called f_fwd!
called f!
ERROR! can't apply forward-mode autodiff (jvp) to a custom_vjp function.

如果你想同时使用前向和反向模式，请改用 jax.custom_jvp。

我们可以将 jax.custom_vjp 与 pdb 一起使用，在后向传播中插入调试器跟踪

import pdb

@custom_vjp
def debug(x):
  return x  # acts like identity

def debug_fwd(x):
  return x, x

def debug_bwd(x, g):
  pdb.set_trace()
  return g

debug.defvjp(debug_fwd, debug_bwd)

def foo(x):
  y = x ** 2
  y = debug(y)  # insert pdb in corresponding backward pass step
  return jnp.sin(y)

jax.grad(foo)(3.)

> <ipython-input-113-b19a2dc1abf7>(12)debug_bwd()
-> return g
(Pdb) p x
Array(9., dtype=float32)
(Pdb) p g
Array(-0.91113025, dtype=float32)
(Pdb) q

针对 JAX 可变换 Python 函数的自定义导数规则

目录

JAX 可变换 Python 函数的自定义导数规则#

TL;DR：使用 `jax.custom_jvp` 定义自定义 JVP#

TL;DR：使用 `jax.custom_vjp` 定义自定义 VJP#

示例问题#

示例：数值稳定性#

示例：强制执行微分约定#

示例：梯度裁剪#

示例：Python 调试#

示例：迭代实现的隐函数微分#

`jax.custom_jvp` 和 `jax.custom_vjp` API 的基本用法#

使用 `jax.custom_jvp` 定义前向模式（以及间接定义反向模式）规则#

使用 `jax.custom_vjp` 定义仅限反向模式的自定义规则#

更多功能与细节#

处理 `list` / `tuple` / `dict` 容器（以及其他 pytree）#

处理不可微分参数#

带有 `nondiff_argnums` 的 `jax.custom_jvp`#

带有 `nondiff_argnums` 的 `jax.custom_vjp`#

针对 JAX 可变换 Python 函数的自定义导数规则

目录

JAX 可变换 Python 函数的自定义导数规则#

TL;DR：使用 jax.custom_jvp 定义自定义 JVP#

TL;DR：使用 jax.custom_vjp 定义自定义 VJP#

示例问题#

示例：数值稳定性#

示例：强制执行微分约定#

示例：梯度裁剪#

示例：Python 调试#

示例：迭代实现的隐函数微分#

jax.custom_jvp 和 jax.custom_vjp API 的基本用法#

使用 jax.custom_jvp 定义前向模式（以及间接定义反向模式）规则#

使用 jax.custom_vjp 定义仅限反向模式的自定义规则#

更多功能与细节#

处理 list / tuple / dict 容器（以及其他 pytree）#

处理不可微分参数#

带有 nondiff_argnums 的 jax.custom_jvp#

带有 nondiff_argnums 的 jax.custom_vjp#

TL;DR：使用 `jax.custom_jvp` 定义自定义 JVP#

TL;DR：使用 `jax.custom_vjp` 定义自定义 VJP#

`jax.custom_jvp` 和 `jax.custom_vjp` API 的基本用法#

使用 `jax.custom_jvp` 定义前向模式（以及间接定义反向模式）规则#

使用 `jax.custom_vjp` 定义仅限反向模式的自定义规则#

处理 `list` / `tuple` / `dict` 容器（以及其他 pytree）#

带有 `nondiff_argnums` 的 `jax.custom_jvp`#

带有 `nondiff_argnums` 的 `jax.custom_vjp`#