torch.distributed.distributed_c10d.Backend Class Reference

Inheritance diagram for torch.distributed.distributed_c10d.Backend:

Public Member Functions
def	__new__ (cls, name)

Static Public Attributes
	UNDEFINED
	GLOO
	NCCL
	MPI
	TCP

Detailed Description

An enum-like class of available backends: GLOO, NCCL, and MPI.

The values of this class are lowercase strings, e.g., ``"gloo"``. They can
be accessed as attributes, e.g., ``Backend.NCCL``.

This class can be directly called to parse the string, e.g.,
``Backend(backend_str)`` will check if ``backend_str`` is valid, and
return the parsed lowercase string if so. It also accepts uppercase strings,
e.g., ``Backend("GLOO")`` returns ``"gloo"``.

.. note:: The entry ``Backend.UNDEFINED`` is present but only used as
          initial value of some fields. Users should neither use it directly
          nor assume its existence.

Definition at line 29 of file distributed_c10d.py.

---

The documentation for this class was generated from the following file:

• torch/distributed/distributed_c10d.py