File: futures.md

package info (click to toggle)
pytorch 2.9.1%2Bdfsg-1~exp2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 180,096 kB
  • sloc: python: 1,473,255; cpp: 942,030; ansic: 79,796; asm: 7,754; javascript: 2,502; java: 1,962; sh: 1,809; makefile: 628; xml: 8
file content (30 lines) | stat: -rw-r--r-- 606 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
```{eval-rst}
.. 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`.

```{eval-rst}
.. automodule:: torch.futures
```

```{eval-rst}
.. autoclass:: Future
    :inherited-members:
```

```{eval-rst}
.. autofunction:: collect_all
```

```{eval-rst}
.. autofunction:: wait_all
```