Class UCX

Declaration

Documentation

Attributes

• ep : ucp.Endpoint
  

  The UCP endpoint.

• address : str
  

  The address, prefixed with `ucx://` to use.

• deserialize : bool, default True
  

  Whether to deserialize data in :meth:`distributed.protocol.loads`

Notes

The read-write cycle uses the following pattern:

Each msg is serialized into a number of "data" frames. We prepend these
real frames with two additional frames

    1. is_gpus: Boolean indicator for whether the frame should be
       received into GPU memory. Packed in '?' format. Unpack with
       ``<n_frames>?`` format.
    2. frame_size : Unsigned int describing the size of frame (in bytes)
       to receive. Packed in 'Q' format, so a length-0 frame is equivalent
       to an unsized frame. Unpacked with ``<n_frames>Q``.

The expected read cycle is

1. Read the frame describing if connection is closing and number of frames
2. Read the frame describing whether each data frame is gpu-bound
3. Read the frame describing whether each data frame is sized
4. Read all the data frames.

Methods

• ▶ def __init__(self, ep, local_addr: str, peer_addr: str, deserialize=True) override

  source link

  This method overrides distributed.comm.core.Comm.__init__.

• ▶ def abort(self) override

  inherited doc Close the communication immediately and abruptly. Useful in destructors or generators' ``finally`` blocks.

  source link

  This method overrides distributed.comm.core.Comm.abort.

• ▶ def closed(self) override

  inherited doc Return whether the stream is closed.

  source link

  This method overrides distributed.comm.core.Comm.closed.

• ▷ def ep(self) @property

  @property
  def ep(self)

  source link
• ▶ def local_address(self) -> str override @property

  inherited doc The local address. For logging and debugging purposes only.

  @property
  def local_address(self)

  source link

  This method overrides distributed.comm.core.Comm.local_address.

• ▶ def peer_address(self) -> str override @property

  inherited doc The peer's address. For logging and debugging purposes only.

  @property
  def peer_address(self)

  source link

  This method overrides distributed.comm.core.Comm.peer_address.

Inherited methods

• Methods inherited from distributed.comm.core.Comm:
  __repr__, close, extra_info, handshake_configuration, handshake_info, read, write

Generated by nedoc v0.9 at 2020-12-29 14:05