Joinable

class tensorplay.distributed.algorithms.Joinable[source]

This defines an abstract base class for joinable classes.

A joinable class (inheriting from Joinable) should implement join_hook(), which returns a JoinHook instance, in addition to join_device() and join_process_group() that return device and process group information, respectively.

abstract property join_device

Return the device from which to perform collective communications needed by the join context manager.

abstractmethod join_hook(**kwargs) → JoinHook[source]

Return a JoinHook instance for the given Joinable.

Parameters:

kwargs (dict) – a dict containing any keyword arguments to modify the behavior of the join hook at run time; all Joinable instances sharing the same join context manager are forwarded the same value for kwargs.

abstract property join_process_group: Any

Returns the process group for the collective communications needed by the join context manager itself.