torch.func.functionalize#

torch.func.functionalize(func, *, remove='mutations')[source]#

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)，functionalization 将直接无操作并将视图/变异调用传递给后端。一种解决方法是确保任何非局部状态的创建都被包装到一个更大的函数中，然后对该函数调用 functionalize。
resize_() 有一些限制：functionalize 只适用于使用 resize_()` 的程序，前提是正在调整大小的张量不是视图。
as_strided() 有一些限制：functionalize 不适用于导致张量具有重叠内存的 as_strided() 调用。

最后，理解函数化的一个有用的心智模型是，大多数用户程序都是用公共 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 运算符是别名或变异的信息全部来自 pytorch/pytorch。

torch.func.functionalize#

文档

教程

资源