torch.func.functional_call

torch.func.functional_call(module, parameter_and_buffer_dicts, args=None, kwargs=None, *, tie_weights=True, strict=False)

透過替換提供的引數和緩衝區，對模組執行函式式呼叫。

注意

如果模組有啟用的引數化，在 parameter_and_buffer_dicts 引數中提供一個名稱設定為常規引數名稱的值將完全停用引數化。如果您想將引數化函式應用於傳遞的值，請將鍵設定為 {submodule_name}.parametrizations.{parameter_name}.original。

注意

如果模組對引數/緩衝區執行就地操作，這些操作將反映在 parameter_and_buffer_dicts 輸入中。

示例

>>> a = {'foo': torch.zeros(())}
>>> mod = Foo()  # does self.foo = self.foo + 1
>>> print(mod.foo)  # tensor(0.)
>>> functional_call(mod, a, torch.ones(()))
>>> print(mod.foo)  # tensor(0.)
>>> print(a['foo'])  # tensor(1.)

注意

如果模組具有共享權重，functional_call 是否尊重共享由 tie_weights 標誌決定。

示例

>>> a = {'foo': torch.zeros(())}
>>> mod = Foo()  # has both self.foo and self.foo_tied which are tied. Returns x + self.foo + self.foo_tied
>>> print(mod.foo)  # tensor(1.)
>>> mod(torch.zeros(()))  # tensor(2.)
>>> functional_call(mod, a, torch.zeros(()))  # tensor(0.) since it will change self.foo_tied too
>>> functional_call(mod, a, torch.zeros(()), tie_weights=False)  # tensor(1.)--self.foo_tied is not updated
>>> new_a = {'foo': torch.zeros(()), 'foo_tied': torch.zeros(())}
>>> functional_call(mod, new_a, torch.zeros()) # tensor(0.)

傳遞多個字典的示例

a = (
    {"weight": torch.ones(1, 1)},
    {"buffer": torch.zeros(1)},
)  # two separate dictionaries
mod = nn.Bar(1, 1)  # return self.weight @ x + self.buffer
print(mod.weight)  # tensor(...)
print(mod.buffer)  # tensor(...)
x = torch.randn((1, 1))
print(x)
functional_call(mod, a, x)  # same as x
print(mod.weight)  # same as before functional_call

下面是一個在模型的引數上應用 grad 變換的示例。

import torch
import torch.nn as nn
from torch.func import functional_call, grad

x = torch.randn(4, 3)
t = torch.randn(4, 3)
model = nn.Linear(3, 3)


def compute_loss(params, x, t):
    y = functional_call(model, params, x)
    return nn.functional.mse_loss(y, t)


grad_weights = grad(compute_loss)(dict(model.named_parameters()), x, t)

注意

如果使用者不需要 grad 轉換之外的 grad 跟蹤，他們可以分離所有引數以提高效能和記憶體使用效率。

示例

>>> detached_params = {k: v.detach() for k, v in model.named_parameters()}
>>> grad_weights = grad(compute_loss)(detached_params, x, t)
>>> grad_weights.grad_fn  # None--it's not tracking gradients outside of grad

這意味著使用者不能呼叫 grad_weight.backward()。但是，如果他們在轉換之外不需要自動梯度跟蹤，這將導致更少的記憶體使用和更快的速度。

引數

• module (torch.nn.Module) – 要呼叫的模組

• parameters_and_buffer_dicts (Dict[str, Tensor] or tuple of Dict[str, Tensor]) – 將在模組呼叫中使用的引數。如果提供一個字典元組，它們必須具有不同的鍵，以便所有字典可以一起使用。

• args (Any or tuple) – 要傳遞給模組呼叫的引數。如果不是元組，則被視為單個引數。

• kwargs (dict) – 要傳遞給模組呼叫的關鍵字引數

• tie_weights (bool, optional) – 如果為 True，則原始模型中共享的引數和緩衝區將被視為在重新引數化的版本中共享。因此，如果為 True 並且為共享引數和緩衝區傳遞了不同的值，則會出錯。如果為 False，則不會尊重原始共享的引數和緩衝區，除非為兩個權重傳遞的值相同。預設為 True。

• strict (bool, optional) – 如果為 True，則傳入的引數和緩衝區必須與原始模組中的引數和緩衝區匹配。因此，如果為 True 並且有任何缺失或意外的鍵，則會出錯。預設為 False。

返回

呼叫 module 的結果。

返回型別

任何