UX 限制¶

与 JAX 一样，torch.func 限制了可以转换的内容。一般来说，JAX 的限制在于转换只能用于纯函数：即输出完全由输入决定且不涉及副作用（如变异）的函数。

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

一般限制¶

所有 torch.func 转换都有一个共同的限制，即函数不应赋值给全局变量。相反，函数的所有输出都必须从函数返回。此限制源于 torch.func 的实现方式：每个转换都将张量输入包装在特殊的 torch.func 张量子类中，以促进转换。

因此，请不要执行以下操作

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 中弹出 1 个元素。

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

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

突变：就地 PyTorch 操作¶

您可能会收到有关与 vmap 不兼容的就地操作的错误而来到这里。如果 vmap() 遇到不受支持的 PyTorch 就地操作，它将引发错误，否则将成功。不受支持的操作是指将导致将包含更多元素的张量写入包含更少元素的张量。以下是如何发生这种情况的一个示例

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 是一个包含一个元素的张量，y 是一个包含三个元素的张量。x + y 有三个元素（由于广播），但尝试将三个元素写回仅包含一个元素的 x 中，由于尝试将三个元素写入一个包含单个元素的张量，因此引发错误。

如果要写入的张量在 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_*”等效项替换对工厂函数的调用。例如

用 Tensor.new_zeros() 替换 torch.zeros()
用 Tensor.new_empty() 替换 torch.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] 的张量。然而，尽管 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)

用 Tensor.new_zeros() 替换 torch.zeros() 之后，result 的底层 Tensor 形状变为 [2, 3, 3]，因此现在可以将底层形状为 [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())¶

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

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

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

请尝试重写代码，避免使用 .item() 调用。

你可能还会遇到有关使用 .item() 的错误消息，但你可能并没有使用它。在这些情况下，PyTorch 内部可能正在调用 .item() - 请在 GitHub 上提交一个问题，我们会修复 PyTorch 内部。

动态形状操作（nonzero 及类似操作）¶

vmap(f) 要求 f 应用于输入中的每个“示例”时返回形状相同的张量。诸如 torch.nonzero、torch.is_nonzero 等操作不受支持，并且因此会出错。

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

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

torch.nonzero(xs[0]) 返回形状为 2 的张量；但 torch.nonzero(xs[1]) 返回形状为 1 的张量。我们无法构建单个张量作为输出；输出需要是稀疏张量（而 PyTorch 还没有稀疏张量的概念）。

随机性¶

用户在调用随机操作时的意图可能不明确。具体来说，一些用户可能希望随机行为在批次之间保持一致，而另一些用户可能希望它在批次之间有所不同。为了解决这个问题，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。相反，我们引入了一个标志系统来允许我们看到的随机性的最常见形式。如果您的用例不适合这些形式的随机性，请提交问题。