在 JAX 中编写自定义 Jaxpr 解释器#

Open in Colab Open in Kaggle

JAX 提供了几种可组合的函数变换（jit、grad、vmap 等），可以编写简洁、加速的代码。

在这里，我们展示了如何通过编写自定义 Jaxpr 解释器，向系统添加你自己的函数变换。并且，你将免费获得与其他所有变换的组合性。

本示例使用 JAX 内部 API，这些 API 可能随时失效。未包含在 API 文档 中的任何内容都应视为内部接口。

import jax
import jax.numpy as jnp
from jax import jit, grad, vmap
from jax import random

JAX 在做什么？#

JAX 提供了类似 NumPy 的数值计算 API，可以直接使用，但 JAX 的真正强大之处在于其可组合的函数变换。以 jit 函数变换为例，它接受一个函数并返回一个语义上相同的函数，但该函数由 XLA 为加速器进行延迟编译。

x = random.normal(random.key(0), (5000, 5000))
def f(w, b, x):
  return jnp.tanh(jnp.dot(x, w) + b)
fast_f = jit(f)

当我们调用 fast_f 时，会发生什么？JAX 追踪该函数并构建一个 XLA 计算图。然后该图被 JIT 编译并执行。其他变换的工作方式类似，它们首先追踪函数并以某种方式处理输出追踪。要了解更多关于 Jax 追踪机制的信息，你可以参考 README 中的 “工作原理” 部分。

Jaxpr 追踪器#

Jax 中一个特别重要的追踪器是 Jaxpr 追踪器，它将操作记录到 Jaxpr（Jax 表达式）中。Jaxpr 是一种可以像迷你函数式编程语言一样进行评估的数据结构，因此 Jaxpr 是函数变换的有用中间表示。

要首次了解 Jaxpr，请考虑 make_jaxpr 变换。make_jaxpr 本质上是一个“美化打印”变换：它将一个函数转换为一个函数，该函数在给定示例参数的情况下，生成其计算的 Jaxpr 表示。make_jaxpr 对于调试和内省很有用。让我们用它来看看一些示例 Jaxpr 的结构。

def examine_jaxpr(closed_jaxpr):
  jaxpr = closed_jaxpr.jaxpr
  print("invars:", jaxpr.invars)
  print("outvars:", jaxpr.outvars)
  print("constvars:", jaxpr.constvars)
  for eqn in jaxpr.eqns:
    print("equation:", eqn.invars, eqn.primitive, eqn.outvars, eqn.params)
  print()
  print("jaxpr:", jaxpr)

def foo(x):
  return x + 1
print("foo")
print("=====")
examine_jaxpr(jax.make_jaxpr(foo)(5))

print()

def bar(w, b, x):
  return jnp.dot(w, x) + b + jnp.ones(5), x
print("bar")
print("=====")
examine_jaxpr(jax.make_jaxpr(bar)(jnp.ones((5, 10)), jnp.ones(5), jnp.ones(10)))

foo
=====
invars: [Var(id=138889319860416):int32[]]
outvars: [Var(id=138889319860480):int32[]]
constvars: []
equation: [Var(id=138889319860416):int32[], Literal(1)] add [Var(id=138889319860480):int32[]] {}

jaxpr: { lambda ; a:i32[]. let b:i32[] = add a 1:i32[] in (b,) }

bar
=====
invars: [Var(id=138889320016000):float32[5,10], Var(id=138889320016640):float32[5], Var(id=138889320014912):float32[10]]
outvars: [Var(id=138889320121216):float32[5], Var(id=138889320014912):float32[10]]
constvars: []
equation: [Var(id=138889320016000):float32[5,10], Var(id=138889320014912):float32[10]] dot_general [Var(id=138889320019776):float32[5]] {'dimension_numbers': (((1,), (0,)), ((), ())), 'precision': None, 'preferred_element_type': dtype('float32'), 'out_sharding': None}
equation: [Var(id=138889320019776):float32[5], Var(id=138889320016640):float32[5]] add [Var(id=138889320120768):float32[5]] {}
equation: [Literal(1.0)] broadcast_in_dim [Var(id=138889320121024):float32[5]] {'shape': (5,), 'broadcast_dimensions': (), 'sharding': None}
equation: [Var(id=138889320120768):float32[5], Var(id=138889320121024):float32[5]] add [Var(id=138889320121216):float32[5]] {}

jaxpr: { lambda ; a:f32[5,10] b:f32[5] c:f32[10]. let
    d:f32[5] = dot_general[
      dimension_numbers=(([1], [0]), ([], []))
      preferred_element_type=float32
    ] a c
    e:f32[5] = add d b
    f:f32[5] = broadcast_in_dim[
      broadcast_dimensions=()
      shape=(5,)
      sharding=None
    ] 1.0:f32[]
    g:f32[5] = add e f
  in (g, c) }

  • jaxpr.invars - Jaxpr 的 invars 是 Jaxpr 输入变量的列表，类似于 Python 函数中的参数。

  • jaxpr.outvars - Jaxpr 的 outvars 是 Jaxpr 返回的变量。每个 Jaxpr 都有多个输出。

  • jaxpr.constvars - constvars 也是 Jaxpr 的输入变量列表，但对应于追踪中的常量（我们稍后将详细介绍这些）。

  • jaxpr.eqns - 一个方程列表，本质上是 let-bindings。每个方程都是一个输入变量列表、一个输出变量列表和一个“原语”（primitive），该原语用于评估输入以产生输出。每个方程还有一个 params，一个参数字典。

总而言之，Jaxpr 封装了一个简单的程序，可以用输入进行评估以产生输出。我们稍后将详细介绍如何做到这一点。现在需要注意的是，Jaxpr 是一种数据结构，我们可以以我们想要的任何方式对其进行操作和评估。

为什么 Jaxpr 很有用？#

Jaxpr 是简单且易于转换的程序表示。由于 Jax 允许我们从 Python 函数中分阶段取出 Jaxpr，这为我们提供了一种转换用 Python 编写的数值程序的方法。

你的第一个解释器：invert#

让我们尝试实现一个简单的函数“反演器”，它接受原始函数的输出并返回产生这些输出的输入。目前，我们关注由其他可逆一元函数组成的简单一元函数。

目标

def f(x):
  return jnp.exp(jnp.tanh(x))
f_inv = inverse(f)
assert jnp.allclose(f_inv(f(1.0)), 1.0)

我们将通过 (1) 将 f 追踪到 Jaxpr 中，然后 (2) 向后解释 Jaxpr 来实现这一点。在向后解释 Jaxpr 时，对于每个方程，我们将在一个表中查找原语的逆并应用它。

1. 追踪函数#

让我们使用 make_jaxpr 将函数追踪到 Jaxpr 中。

# Importing Jax functions useful for tracing/interpreting.
from functools import wraps

from jax import lax
from jax.extend import core
from jax._src.util import safe_map

jax.make_jaxpr 返回一个封闭 Jaxpr，这是一个已与追踪中的常量（literals）捆绑在一起的 Jaxpr。

def f(x):
  return jnp.exp(jnp.tanh(x))

closed_jaxpr = jax.make_jaxpr(f)(jnp.ones(5))
print(closed_jaxpr.jaxpr)
print(closed_jaxpr.literals)

{ lambda ; a:f32[5]. let b:f32[5] = tanh a; c:f32[5] = exp b in (c,) }
[]

2. 评估 Jaxpr#

在编写自定义 Jaxpr 解释器之前，让我们首先实现“默认”解释器 eval_jaxpr，它按原样评估 Jaxpr，计算与原始未变换 Python 函数相同的值。

为此，我们首先创建一个环境来存储每个变量的值，并用我们在 Jaxpr 中评估的每个方程更新环境。

def eval_jaxpr(jaxpr, consts, *args):
  # Mapping from variable -> value
  env = {}

  def read(var):
    # Literals are values baked into the Jaxpr
    if type(var) is core.Literal:
      return var.val
    return env[var]

  def write(var, val):
    env[var] = val

  # Bind args and consts to environment
  safe_map(write, jaxpr.invars, args)
  safe_map(write, jaxpr.constvars, consts)

  # Loop through equations and evaluate primitives using `bind`
  for eqn in jaxpr.eqns:
    # Read inputs to equation from environment
    invals = safe_map(read, eqn.invars)
    # `bind` is how a primitive is called
    outvals = eqn.primitive.bind(*invals, **eqn.params)
    # Primitives may return multiple outputs or not
    if not eqn.primitive.multiple_results:
      outvals = [outvals]
    # Write the results of the primitive into the environment
    safe_map(write, eqn.outvars, outvals)
  # Read the final result of the Jaxpr from the environment
  return safe_map(read, jaxpr.outvars)

closed_jaxpr = jax.make_jaxpr(f)(jnp.ones(5))
eval_jaxpr(closed_jaxpr.jaxpr, closed_jaxpr.literals, jnp.ones(5))

[Array([2.1416876, 2.1416876, 2.1416876, 2.1416876, 2.1416876], dtype=float32)]

请注意，即使原始函数不是扁平列表，eval_jaxpr 也将始终返回一个扁平列表。

此外，此解释器不处理高阶原语（如 jit 和 pmap），本指南不对此进行涵盖。你可以参考 core.eval_jaxpr（链接）以查看此解释器未涵盖的边缘情况。

自定义 inverse Jaxpr 解释器#

一个 inverse 解释器与 eval_jaxpr 没有太大区别。我们首先设置将原语映射到其逆的注册表。然后我们将编写一个在注册表中查找原语的自定义解释器。

事实证明，此解释器也将与反向模式自动微分中使用的“转置”解释器相似，请在此处查看。

inverse_registry = {}

我们现在将为一些原语注册逆。按照惯例，Jax 中的原语以 _p 结尾，许多流行的原语都位于 lax 中。

inverse_registry[lax.exp_p] = jnp.log
inverse_registry[lax.tanh_p] = jnp.arctanh

inverse 将首先追踪函数，然后自定义解释 Jaxpr。让我们设置一个简单的骨架。

def inverse(fun):
  @wraps(fun)
  def wrapped(*args, **kwargs):
    # Since we assume unary functions, we won't worry about flattening and
    # unflattening arguments.
    closed_jaxpr = jax.make_jaxpr(fun)(*args, **kwargs)
    out = inverse_jaxpr(closed_jaxpr.jaxpr, closed_jaxpr.literals, *args)
    return out[0]
  return wrapped

现在我们只需要定义 inverse_jaxpr，它将向后遍历 Jaxpr 并在可能时反转原语。

def inverse_jaxpr(jaxpr, consts, *args):
  env = {}

  def read(var):
    if type(var) is core.Literal:
      return var.val
    return env[var]

  def write(var, val):
    env[var] = val
  # Args now correspond to Jaxpr outvars
  safe_map(write, jaxpr.outvars, args)
  safe_map(write, jaxpr.constvars, consts)

  # Looping backward
  for eqn in jaxpr.eqns[::-1]:
    #  outvars are now invars
    invals = safe_map(read, eqn.outvars)
    if eqn.primitive not in inverse_registry:
      raise NotImplementedError(
          f"{eqn.primitive} does not have registered inverse.")
    # Assuming a unary function
    outval = inverse_registry[eqn.primitive](*invals)
    safe_map(write, eqn.invars, [outval])
  return safe_map(read, jaxpr.invars)

就是这样！

def f(x):
  return jnp.exp(jnp.tanh(x))

f_inv = inverse(f)
assert jnp.allclose(f_inv(f(1.0)), 1.0)

重要的是，你可以通过 Jaxpr 解释器进行追踪。

jax.make_jaxpr(inverse(f))(f(1.))

{ lambda ; a:f32[]. let b:f32[] = log a; c:f32[] = atanh b in (c,) }

这就是向系统添加新变换所需的全部，并且你免费获得了与所有其他变换的组合！例如，我们可以将 jit、vmap 和 grad 与 inverse 结合使用！

jit(vmap(grad(inverse(f))))((jnp.arange(5) + 1.) / 5.)

Array([-3.1440797, 15.584931 ,  2.2551253,  1.3155028,  1.       ],      dtype=float32, weak_type=True)

留给读者的练习#

  • 处理输入部分已知且具有多个参数的原语，例如 lax.add_p、lax.mul_p。

  • 处理 xla_call 和 xla_pmap 原语，它们无法按当前编写方式与 eval_jaxpr 和 inverse_jaxpr 一起工作。