UX 限制¶

torch.func，与 JAX 类似，对可转换的内容有限制。一般来说，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 映射到每个输入 Tensor 的某个新维度上。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 处理的 Tensor 中值的控制流都将正常工作

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 应用于输入中的每个“示例”时返回具有相同形状的 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 作为输出；输出需要是一个不规则（ragged）Tensor（而 PyTorch 尚未有不规则 Tensor 的概念）。

随机性¶

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

该标志只能传递给 vmap，可以取三个值：“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。相反，我们引入了一个标志系统，以支持我们看到的最常见的随机性形式。如果你的用例不符合这些随机性形式，请提交问题。