torch.jit.fork

torch.jit.fork(func, *args, **kwargs)

创建一个执行 func 的异步任务，并返回对该执行结果值的引用。

函数 fork 会立即返回，因此 func 的返回值可能尚未计算完毕。要强制完成任务并访问返回值，请在 Future 上调用 torch.jit.wait。以返回 T 的 func 调用的 fork 类型为 torch.jit.Future[T]。fork 调用可以任意嵌套，并且可以使用位置参数和关键字参数进行调用。异步执行仅在 TorchScript 中运行时才会发生。如果在纯 Python 中运行，fork 将不会并行执行。fork 在追踪（tracing）时也不会并行执行，但 fork 和 wait 调用将被捕获在导出的 IR 图中。

警告

fork 任务将以非确定性方式执行。我们建议仅对不修改输入、模块属性或全局状态的纯函数创建并行 fork 任务。

参数

• func (可调用对象或 torch.nn.Module) – 要调用的 Python 函数或 torch.nn.Module。如果在 TorchScript 中执行，它将异步运行，否则不会。对 fork 的追踪调用将被捕获在 IR 中。

• *args – 用于调用 func 的参数。

• **kwargs – 用于调用 func 的参数。

返回

对 func 执行的引用。值 T 只能通过 torch.jit.wait 强制完成 func 后才能访问。

返回类型

torch.jit.Future[T]

示例（分叉一个自由函数）

import torch
from torch import Tensor


def foo(a: Tensor, b: int) -> Tensor:
    return a + b


def bar(a):
    fut: torch.jit.Future[Tensor] = torch.jit.fork(foo, a, b=2)
    return torch.jit.wait(fut)


script_bar = torch.jit.script(bar)
input = torch.tensor(2)
# only the scripted version executes asynchronously
assert script_bar(input) == bar(input)
# trace is not run asynchronously, but fork is captured in IR
graph = torch.jit.trace(bar, (input,)).graph
assert "fork" in str(graph)

示例（分叉一个模块方法）

import torch
from torch import Tensor


class AddMod(torch.nn.Module):
    def forward(self, a: Tensor, b: int):
        return a + b


class Mod(torch.nn.Module):
    def __init__(self) -> None:
        super(self).__init__()
        self.mod = AddMod()

    def forward(self, input):
        fut = torch.jit.fork(self.mod, a, b=2)
        return torch.jit.wait(fut)


input = torch.tensor(2)
mod = Mod()
assert mod(input) == torch.jit.script(mod).forward(input)