tensorplay.distributed.elastic.rendezvous API

Coordinate membership, ranks, heartbeats, and round transitions.

pre_shutdown() → None

Optional hook invoked before shutdown() during agent teardown.

Rendezvous state backend backed by a TP key/value Store.

Algorithmic interface of one rendezvous backend.

abstractmethod get_backend() → str[source]

Backend name (e.g. static or core).

abstractmethod get_run_id() → str[source]

Run identifier of this rendezvous.

abstractmethod is_closed() → bool[source]

Whether the rendezvous has been marked closed.

abstractmethod next_rendezvous() → RendezvousInfo[source]

Join or re-join the rendezvous; blocks until this round completes.

abstractmethod num_nodes_waiting() → int[source]

Number of nodes queued for the next round (pending scale-up).

pre_shutdown() → None[source]

Optional hook invoked before shutdown() during agent teardown.

abstractmethod set_closed() → None[source]

Mark the rendezvous closed; new joiners are rejected.

abstractmethod shutdown() → bool[source]

Release rendezvous resources; returns True when the backend shut down.

property use_agent_store: bool

Whether workers can reuse the agent-held store as their bootstrap store.

Outcome of a successful rendezvous for one agent.

property bootstrap_store_info: RendezvousStoreInfo | None

Connection info for the worker-facing bootstrap store.

property participants: list

Nodes participating in this round.

property rank: int

This agent’s rank within the rendezvous.

property store: Store

Shared store for this rendezvous round.

property wait_list: list

Nodes waiting for a future round.

property world_size: int

Number of participating agents.

Parameters describing one rendezvous request.

endpoint is host:port of the rendezvous store, local_addr the address of this node (autodetected when empty), and config carries backend-specific options accessible through get().

get(key: str, default=None)[source]

Return backend parameter key or default.

get_as_bool(key: str, default: bool | None = None) → bool | None[source]

Return key coerced to bool (accepts 1/0/true/false).

get_as_int(key: str, default: int | None = None) → int | None[source]

Return key coerced to int.

property timeout: RendezvousTimeout

Timeouts assembled from join/last_call/close/heartbeat params (seconds).

Configuration shared by the rendezvous state machine.

Connection information for the bootstrap store handed to workers.

property addr: str

Alias of master_addr.

classmethod build(rank: int, store: Store, local_addr: str | None = None, server_port: int | None = None)[source]

Derive store info for rank from the rendezvous store.

Rank 0 owns the address/port pair: it uses the store’s own listening endpoint when available and otherwise publishes one through the store so every other rank can read it.

One-shot rendezvous over a static TCPStore endpoint.

pre_shutdown() → None

Optional hook invoked before shutdown() during agent teardown.

Store rendezvous state behind compare-and-set operations.