torch.futures

创建日期：2025 年 6 月 12 日 | 最后更新日期：2025 年 6 月 12 日

此包提供了一个 Future 类型，用于封装异步执行，以及一组简化 Future 对象操作的实用函数。目前，Future 类型主要由 分布式 RPC 框架 使用。

class torch.futures.Future(*, devices=None)

torch._C.Future 的包装器，用于封装可调用对象的异步执行，例如 rpc_async()。它还公开了一组 API 来添加回调函数和设置结果。

警告

GPU 支持是测试版功能，可能会有变化。

add_done_callback(callback)

将给定的回调函数附加到此 Future，该回调函数将在 Future 完成时运行。可以向同一个 Future 添加多个回调，但无法保证它们的执行顺序。回调必须接受一个参数，即对此 Future 的引用。回调函数可以使用 value() 方法获取值。请注意，如果此 Future 已完成，则给定的回调将立即运行。

我们建议您使用 then() 方法，因为它提供了一种在回调完成后进行同步的方式。add_done_callback 如果您的回调不返回任何内容，则可能更便宜。但 then() 和 add_done_callback 都使用相同的回调注册 API。

对于 GPU 张量，此方法的行为方式与 then() 相同。

参数

callback (Future) – 一个 Callable，它接受一个参数，即对此 Future 的引用。

注意

请注意，如果回调函数抛出异常，无论是由于原始 Future 完成时带有异常并调用了 fut.wait()，还是由于回调中的其他代码，都必须仔细处理错误。例如，如果此回调稍后完成额外的 Future，则这些 Future 不会被标记为完成并带有错误，用户需要独立处理这些 Future 的完成/等待。

示例

>>> def callback(fut):
...     print("This will run after the future has finished.")
...     print(fut.wait())
>>> fut = torch.futures.Future()
>>> fut.add_done_callback(callback)
>>> fut.set_result(5)
This will run after the future has finished.
5

done()

如果此 Future 已完成，则返回 True。如果 Future 有结果或异常，则表示已完成。

如果值包含位于 GPU 上的张量，即使填充这些张量的异步核尚未在设备上完成运行，Future.done() 仍将返回 True，因为在此阶段，结果已经可用，前提是执行了适当的同步（参见 wait()）。

返回类型

布尔值

set_exception(result)

为此 Future 设置一个异常，这将把此 Future 标记为完成并带有错误，并触发所有附加的回调。请注意，当对此 Future 调用 wait()/value() 时，此处设置的异常将以内联方式抛出。

参数

result (BaseException) – 此 Future 的异常。

示例

>>> fut = torch.futures.Future()
>>> fut.set_exception(ValueError("foo"))
>>> fut.wait()
Traceback (most recent call last):
...
ValueError: foo

set_result(result)

为此 Future 设置结果，这将把此 Future 标记为已完成并触发所有附加的回调。请注意，Future 不能被标记为已完成两次。

如果结果包含位于 GPU 上的张量，即使填充这些张量的异步核尚未在设备上完成运行，此方法也可以被调用，前提是调用此方法时，这些核被入队的流被设置为当前流。简单地说，只要在调用这些核后立即调用此方法，并且期间不更改流，就可以安全地调用此方法而无需任何额外的同步。此方法将在所有相关的当前流上记录事件，并使用它们来确保为此 Future 的所有消费者进行适当的调度。

参数

result (object) – 此 Future 的结果对象。

示例

>>> import threading
>>> import time
>>> def slow_set_future(fut, value):
...     time.sleep(0.5)
...     fut.set_result(value)
>>> fut = torch.futures.Future()
>>> t = threading.Thread(
...     target=slow_set_future,
...     args=(fut, torch.ones(2) * 3)
... )
>>> t.start()
>>> print(fut.wait())
tensor([3., 3.])
>>> t.join()

then(callback)

将给定的回调函数附加到此 Future，该函数将在 Future 完成时运行。可以将多个回调添加到同一个 Future，但无法保证它们的执行顺序（要强制执行特定顺序，请考虑链式调用：fut.then(cb1).then(cb2)）。回调必须接受一个参数，该参数是对此 Future 的引用。回调函数可以使用 value() 方法获取值。请注意，如果此 Future 已完成，则给定的回调将立即内联运行。

如果 Future 的值包含位于 GPU 上的张量，则回调可能会在填充这些张量的异步核尚未在设备上完成执行时被调用。但是，回调将以一些专用的流（从全局池中获取）作为当前流进行调用，这些流将与这些核同步。因此，回调对这些张量执行的任何操作都将在核完成后在设备上调度。换句话说，只要回调不切换流，它就可以安全地操作结果而无需任何额外的同步。这类似于 wait() 的非阻塞行为。

类似地，如果回调返回的值包含位于 GPU 上的张量，即使生成这些张量的核仍在设备上运行，它也可以这样做，只要回调在其执行期间没有更改流。如果需要更改流，则必须小心地将它们与原始流重新同步，即那些在回调被调用时为当前流的流。

参数

callback (Callable) – 一个以此 Future 作为唯一参数的 Callable。

返回

一个新的 Future 对象，它保存 callback 的返回值，并在给定 callback 完成时被标记为完成。

返回类型

Future[S]

注意

请注意，如果回调函数抛出异常，无论是由于原始 Future 完成时带有异常并调用了 fut.wait()，还是由于回调中的其他代码，then 返回的 Future 都将适当地标记为遇到的错误。但是，如果此回调稍后完成额外的 Future，则这些 Future 不会被标记为完成并带有错误，用户需要独立处理这些 Future 的完成/等待。

示例

>>> def callback(fut):
...     print(f"RPC return value is {fut.wait()}.")
>>> fut = torch.futures.Future()
>>> # The inserted callback will print the return value when
>>> # receiving the response from "worker1"
>>> cb_fut = fut.then(callback)
>>> chain_cb_fut = cb_fut.then(
...     lambda x : print(f"Chained cb done. {x.wait()}")
... )
>>> fut.set_result(5)
RPC return value is 5.
Chained cb done. None

value()

获取已完成 Future 的值。

此方法应仅在调用 wait() 完成后，或在传递给 then() 的回调函数内部调用。在其他情况下，此 Future 可能尚未持有值，调用 value() 可能会失败。

如果值包含位于 GPU 上的张量，则此方法将不会执行任何额外的同步。这应该事先单独完成，通过调用 wait()（回调内部除外，因为 then() 已经处理了）。

返回

此 Future 持有的值。如果创建值的函数（回调或 RPC）抛出了错误，此 value() 方法也将抛出错误。

返回类型

T

wait()

阻塞直到此 Future 的值准备就绪。

如果值包含位于 GPU 上的张量，则将与可能异步填充这些张量的核（在设备上执行）进行额外同步。这种同步是非阻塞的，这意味着 wait() 将在当前流中插入必要的指令，以确保在异步核之后正确调度这些流上的后续操作，但一旦完成，wait() 将返回，即使这些核仍在运行。只要不改变流，访问和使用值时就不需要进一步同步。

返回

此 Future 持有的值。如果创建值的函数（回调或 RPC）抛出了错误，此 wait 方法也将抛出错误。

返回类型

T

torch.futures.collect_all(futures)

将提供的 Future 对象收集到一个单一的组合 Future 中，当所有子 Future 都完成后，该组合 Future 也完成。

参数

futures (list) – Future 对象的列表。

返回

返回一个 Future 对象，该对象是传入 Future 的列表。

返回类型

Future[list[torch.jit.Future]]

示例：

>>> fut0 = torch.futures.Future()
>>> fut1 = torch.futures.Future()
>>> fut = torch.futures.collect_all([fut0, fut1])
>>> fut0.set_result(0)
>>> fut1.set_result(1)
>>> fut_list = fut.wait()
>>> print(f"fut0 result = {fut_list[0].wait()}")
fut0 result = 0
>>> print(f"fut1 result = {fut_list[1].wait()}")
fut1 result = 1

torch.futures.wait_all(futures)

等待所有提供的 Future 完成，并返回已完成值的列表。如果任何 Future 遇到错误，该方法将提前退出并报告错误，而不等待其他 Future 完成。

参数

futures (list) – Future 对象的列表。

返回

已完成 Future 结果的列表。如果对任何 Future 调用 wait 抛出错误，此方法也将抛出错误。

返回类型

列表