UX 限制¶

与 JAX 类似，torch.func 对可以转换的内容有限制。通常，JAX 的限制是转换仅适用于纯函数：即输出完全由输入决定且不涉及副作用（如突变）的函数。

我们有类似的保证：我们的转换非常适用于纯函数。但是，我们确实支持某些原地操作。一方面，编写与函数转换兼容的代码可能需要更改您编写 PyTorch 代码的方式，另一方面，您可能会发现我们的转换使您可以表达以前在 PyTorch 中难以表达的内容。

一般限制¶

所有 torch.func 转换都存在一个共同的限制，即函数不应分配给全局变量。相反，函数的所有输出都必须从函数返回。此限制来自 torch.func 的实现方式：每个转换都将 Tensor 输入包装在特殊的 torch.func Tensor 子类中，以方便转换。

所以，代替以下内容

import torch
from torch.func import grad

# Don't do this
intermediate = None

def f(x):
  global intermediate
  intermediate = x.sin()
  z = intermediate.sin()
  return z

x = torch.randn([])
grad_x = grad(f)(x)

请重写 f 以返回 intermediate

def f(x):
  intermediate = x.sin()
  z = intermediate.sin()
  return z, intermediate

grad_x, intermediate = grad(f, has_aux=True)(x)

torch.autograd API¶

如果您尝试在被 vmap() 或 torch.func 的 AD 转换 (vjp(), jvp(), jacrev(), jacfwd()) 转换的函数内部使用 torch.autograd API（如 torch.autograd.grad 或 torch.autograd.backward），则转换可能无法在其上进行转换。如果无法执行此操作，您将收到错误消息。

这是 PyTorch 的 AD 支持实现方式的根本设计限制，也是我们设计 torch.func 库的原因。请改用 torch.autograd API 的 torch.func 等效项： - torch.autograd.grad, Tensor.backward -> torch.func.vjp 或 torch.func.grad - torch.autograd.functional.jvp -> torch.func.jvp - torch.autograd.functional.jacobian -> torch.func.jacrev 或 torch.func.jacfwd - torch.autograd.functional.hessian -> torch.func.hessian

vmap 限制¶

注意

vmap() 是我们限制最多的转换。与梯度相关的转换 (grad(), vjp(), jvp()) 没有这些限制。jacfwd() (和 hessian()，它使用 jacfwd() 实现) 是 vmap() 和 jvp() 的组合，因此它也具有这些限制。

vmap(func) 是一种转换，它返回一个函数，该函数将 func 映射到每个输入张量的一些新维度上。vmap 的心智模型是它就像运行一个 for 循环：对于纯函数（即在没有副作用的情况下），vmap(f)(x) 等效于

torch.stack([f(x_i) for x_i in x.unbind(0)])

突变：Python 数据结构的任意突变¶

在存在副作用的情况下，vmap() 不再像运行 for 循环那样运行。例如，以下函数

def f(x, list):
  list.pop()
  print("hello!")
  return x.sum(0)

x = torch.randn(3, 1)
lst = [0, 1, 2, 3]

result = vmap(f, in_dims=(0, None))(x, lst)

将打印 “hello!” 一次，并且仅从 lst 中弹出一个元素。

vmap() 执行 f 一次，因此所有副作用仅发生一次。

这是 vmap 实现方式的后果。torch.func 具有特殊的内部 BatchedTensor 类。vmap(f)(*inputs) 接受所有 Tensor 输入，将它们转换为 BatchedTensor，并调用 f(*batched_tensor_inputs)。BatchedTensor 覆盖 PyTorch API，为每个 PyTorch 运算符生成批处理（即向量化）行为。

突变：原地 PyTorch 操作¶

您可能因为收到有关 vmap 不兼容的原地操作的错误而来到这里。vmap() 如果遇到不受支持的 PyTorch 原地操作，则会引发错误，否则将成功。不受支持的操作是指那些会导致将具有更多元素的 Tensor 写入到具有较少元素的 Tensor 的操作。以下是这种情况如何发生的示例

def f(x, y):
  x.add_(y)
  return x

x = torch.randn(1)
y = torch.randn(3, 1)  # When vmapped over, looks like it has shape [1]

# Raises an error because `x` has fewer elements than `y`.
vmap(f, in_dims=(None, 0))(x, y)

x 是一个具有一个元素的 Tensor，y 是一个具有三个元素的 Tensor。x + y 具有三个元素（由于广播），但尝试将三个元素写回仅具有一个元素的 x 会引发错误，因为尝试将三个元素写入到具有单个元素的 Tensor 中。

如果要写入的 Tensor 在 vmap() 下进行批处理（即正在对其进行 vmap），则没有问题。

def f(x, y):
  x.add_(y)
  return x

x = torch.randn(3, 1)
y = torch.randn(3, 1)
expected = x + y

# Does not raise an error because x is being vmapped over.
vmap(f, in_dims=(0, 0))(x, y)
assert torch.allclose(x, expected)

对此的常见修复方法是将对工厂函数的调用替换为其 “new_*” 等效项。例如

将 torch.zeros() 替换为 Tensor.new_zeros()
将 torch.empty() 替换为 Tensor.new_empty()

要了解这为什么有帮助，请考虑以下情况。

def diag_embed(vec):
  assert vec.dim() == 1
  result = torch.zeros(vec.shape[0], vec.shape[0])
  result.diagonal().copy_(vec)
  return result

vecs = torch.tensor([[0., 1, 2], [3., 4, 5]])

# RuntimeError: vmap: inplace arithmetic(self, *extra_args) is not possible ...
vmap(diag_embed)(vecs)

在 vmap() 内部，result 是形状为 [3, 3] 的 Tensor。但是，尽管 vec 看起来形状为 [3]，但 vec 实际上具有形状 [2, 3]。不可能将 vec 复制到形状为 [3] 的 result.diagonal() 中，因为它具有太多元素。

def diag_embed(vec):
  assert vec.dim() == 1
  result = vec.new_zeros(vec.shape[0], vec.shape[0])
  result.diagonal().copy_(vec)
  return result

vecs = torch.tensor([[0., 1, 2], [3., 4, 5]])
vmap(diag_embed)(vecs)

将 torch.zeros() 替换为 Tensor.new_zeros() 使 result 具有形状为 [2, 3, 3] 的底层 Tensor，因此现在可以将具有形状 [2, 3] 的 vec 复制到 result.diagonal() 中。

突变：out= PyTorch 操作¶

vmap() 不支持 PyTorch 操作中的 out= 关键字参数。如果在您的代码中遇到这种情况，它将优雅地报错。

这不是根本的限制；理论上我们可以在将来支持此功能，但我们目前选择不这样做。

数据相关的 Python 控制流¶

我们尚不支持在数据相关的控制流上使用 vmap。数据相关的控制流是指 if 语句、while 循环或 for 循环的条件是一个正在进行 vmap 处理的 Tensor。例如，以下代码将引发错误消息

def relu(x):
  if x > 0:
    return x
  return 0

x = torch.randn(3)
vmap(relu)(x)

但是，任何不依赖于 vmap 处理的张量中的值的控制流都将有效

def custom_dot(x):
  if x.dim() == 1:
    return torch.dot(x, x)
  return (x * x).sum()

x = torch.randn(3)
vmap(custom_dot)(x)

JAX 支持使用特殊的控制流运算符（例如 jax.lax.cond, jax.lax.while_loop）在数据相关的控制流上进行转换。我们正在研究向 PyTorch 添加这些运算符的等效项。

数据相关操作 (.item())¶

我们不（也不会）支持在用户定义的函数上使用 vmap，该函数在 Tensor 上调用 .item()。例如，以下代码将引发错误消息

def f(x):
  return x.item()

x = torch.randn(3)
vmap(f)(x)

请尝试重写您的代码，使其不使用 .item() 调用。

您也可能会遇到关于使用 .item() 的错误消息，但您可能没有使用它。在这些情况下，可能是 PyTorch 内部正在调用 .item() – 请在 GitHub 上提交问题，我们将修复 PyTorch 内部代码。

动态形状操作（nonzero 和 friends）¶

vmap(f) 要求应用于输入中每个“示例”的 f 返回形状相同的 Tensor。不支持 torch.nonzero、torch.is_nonzero 等操作，并且会导致错误。

要了解原因，请考虑以下示例

xs = torch.tensor([[0, 1, 2], [0, 0, 3]])
vmap(torch.nonzero)(xs)

torch.nonzero(xs[0]) 返回形状为 2 的 Tensor；但 torch.nonzero(xs[1]) 返回形状为 1 的 Tensor。我们无法构造单个 Tensor 作为输出；输出需要是参差不齐的 Tensor（而 PyTorch 尚不具备参差不齐的 Tensor 的概念）。

随机性¶

用户在调用随机操作时的意图可能不明确。具体来说，一些用户可能希望批次之间的随机行为相同，而另一些用户可能希望批次之间的随机行为不同。为了解决这个问题，vmap 接受一个随机性标志。

该标志只能传递给 vmap，并且可以采用 3 个值，“error”、“different” 或 “same”，默认为 error。在 “error” 模式下，对随机函数的任何调用都会产生一个错误，要求用户根据其用例使用其他两个标志之一。

在 “different” 随机性下，批次中的元素产生不同的随机值。例如，

def add_noise(x):
  y = torch.randn(())  # y will be different across the batch
  return x + y

x = torch.ones(3)
result = vmap(add_noise, randomness="different")(x)  # we get 3 different values

在 “same” 随机性下，批次中的元素产生相同的随机值。例如，

def add_noise(x):
  y = torch.randn(())  # y will be the same across the batch
  return x + y

x = torch.ones(3)
result = vmap(add_noise, randomness="same")(x)  # we get the same value, repeated 3 times

警告

我们的系统仅确定 PyTorch 运算符的随机性行为，无法控制其他库（如 numpy）的行为。这类似于 JAX 在其解决方案中的限制

注意

使用任何一种受支持的随机性的多个 vmap 调用不会产生相同的结果。与标准 PyTorch 类似，用户可以通过在 vmap 外部使用 torch.manual_seed() 或使用生成器来获得随机性可重复性。

注意

最后，我们的随机性与 JAX 不同，因为我们没有使用无状态 PRNG，部分原因是 PyTorch 不完全支持无状态 PRNG。相反，我们引入了一个标志系统，以允许我们看到的最常见的随机性形式。如果您的用例不符合这些随机性形式，请提交问题。