pytorch/docs/source/futures.rst
chronos_secgrp_pytorch_oss_ci_oncall ef9586b10b 2021-05-12 nightly release (0d4dc6cb39)
2021-05-12 00:03:01 -07:00

20 lines
529 B
ReStructuredText

.. currentmodule:: torch.futures
.. _futures-docs:
torch.futures
=============
This package provides a :class:`~torch.futures.Future` type that encapsulates
an asynchronous execution and a set of utility functions to simplify operations
on :class:`~torch.futures.Future` objects. Currently, the
:class:`~torch.futures.Future` type is primarily used by the
:ref:`distributed-rpc-framework`.
.. automodule:: torch.futures
.. autoclass:: Future
:inherited-members:
.. autofunction:: collect_all
.. autofunction:: wait_all