docs/source/futures.rst

.. currentmodule:: torch.futures

.. _futures-docs:

torch.futures
=============

.. warning::
  The ``torch.futures`` package is experimental and subject to change.


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
    :members:

.. autofunction:: collect_all
.. autofunction:: wait_all