torch.func.functionalize¶

torch.func.functionalize(func, *, remove='mutations')[源代码]¶

functionalize 是一种转换，可用于从函数中删除（中间）突变和别名，同时保留函数的语义。

functionalize(func) 返回一个新函数，该函数具有与 func 相同的语义，但删除了所有中间突变。对中间张量执行的每个原地操作：intermediate.foo_() 都被其异地等效操作替换：intermediate_updated = intermediate.foo()。

functionalize 对于将 pytorch 程序发送到无法轻松表示突变或别名运算符的后端或编译器非常有用。

参数

func (Callable) – 一个接受一个或多个参数的 Python 函数。
remove (str) – 一个可选的字符串参数，可以取值 ‘mutations’ 或 ‘mutations_and_views’。如果传入 ‘mutations’，则所有突变运算符都将被替换为它们的非突变等效运算符。如果传入 ‘mutations_and_views’，则此外，所有别名运算符都将被替换为它们的非别名等效运算符。默认值：‘mutations’。

返回

返回一个新的“函数化”函数。它接受与 func 相同的输入，并具有相同的行为，但是函数中间张量上执行的任何突变（以及可选的别名）都将被删除。

返回类型

Callable

functionalize 还会删除对函数输入执行的突变（和视图）。但是，为了保留语义，functionalize 将在转换完成后“修复”突变，方法是检测是否有任何张量输入“应该”被突变，并在必要时将新数据复制回输入。

示例

>>> import torch
>>> from torch.fx.experimental.proxy_tensor import make_fx
>>> from torch.func import functionalize
>>>
>>> # A function that uses mutations and views, but only on intermediate tensors.
>>> def f(a):
...     b = a + 1
...     c = b.view(-1)
...     c.add_(1)
...     return b
...
>>> inpt = torch.randn(2)
>>>
>>> out1 = f(inpt)
>>> out2 = functionalize(f)(inpt)
>>>
>>> # semantics are the same (outputs are equivalent)
>>> print(torch.allclose(out1, out2))
True
>>>
>>> f_traced = make_fx(f)(inpt)
>>> f_no_mutations_traced = make_fx(functionalize(f))(inpt)
>>> f_no_mutations_and_views_traced = make_fx(functionalize(f, remove='mutations_and_views'))(inpt)
>>>
>>> print(f_traced.code)



def forward(self, a_1):
    add = torch.ops.aten.add(a_1, 1);  a_1 = None
    view = torch.ops.aten.view(add, [-1])
    add_ = torch.ops.aten.add_(view, 1);  view = None
    return add

>>> print(f_no_mutations_traced.code)



def forward(self, a_1):
    add = torch.ops.aten.add(a_1, 1);  a_1 = None
    view = torch.ops.aten.view(add, [-1]);  add = None
    add_1 = torch.ops.aten.add(view, 1);  view = None
    view_1 = torch.ops.aten.view(add_1, [2]);  add_1 = None
    return view_1

>>> print(f_no_mutations_and_views_traced.code)



def forward(self, a_1):
    add = torch.ops.aten.add(a_1, 1);  a_1 = None
    view_copy = torch.ops.aten.view_copy(add, [-1]);  add = None
    add_1 = torch.ops.aten.add(view_copy, 1);  view_copy = None
    view_copy_1 = torch.ops.aten.view_copy(add_1, [2]);  add_1 = None
    return view_copy_1


>>> # A function that mutates its input tensor
>>> def f(a):
...     b = a.view(-1)
...     b.add_(1)
...     return a
...
>>> f_no_mutations_and_views_traced = make_fx(functionalize(f, remove='mutations_and_views'))(inpt)
>>> #
>>> # All mutations and views have been removed,
>>> # but there is an extra copy_ in the graph to correctly apply the mutation to the input
>>> # after the function has completed.
>>> print(f_no_mutations_and_views_traced.code)



def forward(self, a_1):
    view_copy = torch.ops.aten.view_copy(a_1, [-1])
    add = torch.ops.aten.add(view_copy, 1);  view_copy = None
    view_copy_1 = torch.ops.aten.view_copy(add, [2]);  add = None
    copy_ = torch.ops.aten.copy_(a_1, view_copy_1);  a_1 = None
    return view_copy_1

functionalize 有一些“失败模式”值得指出

与其他 torch.func 转换一样，functionalize() 不适用于直接使用 .backward() 的函数。torch.autograd.grad 也是如此。如果您想使用 autograd，您可以直接使用 functionalize(grad(f)) 计算梯度。
与其他 torch.func 转换一样，functionalize() 不适用于全局状态。如果您对一个函数调用 functionalize(f)，该函数接受非本地状态的视图/突变，则函数化将简单地执行空操作，并将视图/突变调用直接传递给后端。解决此问题的一种方法是确保将任何非本地状态创建包装到一个更大的函数中，然后对该函数调用 functionalize。
resize_() 有一些限制：functionalize 仅适用于使用 resize_()` 的程序，前提是被调整大小的张量不是视图。
as_strided() 有一些限制：functionalize 不适用于导致具有重叠内存的张量的 as_strided() 调用。

最后，理解函数化的一个有用的心智模型是，大多数用户 pytorch 程序都是使用公共 torch API 编写的。执行时，torch 运算符通常被分解为我们的内部 C++ “ATen” API。函数化的逻辑完全发生在 ATen 级别。函数化知道如何获取 ATen 中的每个别名运算符，并将其映射到其非别名等效运算符（例如 tensor.view({-1}) -> at::view_copy(tensor, {-1})），以及如何获取 ATen 中的每个突变运算符，并将其映射到其非突变等效运算符（例如 tensor.add_(1) -> at::add(tensor, -1)），同时跟踪别名和突变以了解何时修复问题。有关哪些 ATen 运算符是别名或突变的信息都来自 https://github.com/pytorch/pytorch/blob/master/aten/src/ATen/native/native_functions.yaml。

torch.func.functionalize¶

文档

教程

资源