Events

模組包含與標準 Python 記錄整合的事件處理機制。

使用範例

from torch.distributed.elastic import events
event = events.Event(name="test_event", source=events.EventSource.WORKER, metadata={...})
events.get_logging_handler(destination="console").info(event)

API 方法

torch.distributed.elastic.events.record(event, destination='null')

torch.distributed.elastic.events.construct_and_record_rdzv_event(run_id, message, node_state, name='', hostname='', pid=None, master_endpoint='', local_id=None, rank=None)

初始化 rendezvous 事件物件並記錄其操作。

參數

• run_id (str) – rendezvous 的執行 ID。

• message (str) – 描述事件的訊息。

• node_state (NodeState) – 節點的狀態 (INIT, RUNNING, SUCCEEDED, FAILED)。

• name (str) – 事件名稱。（例如：目前執行的動作）。

• hostname (str) – 節點的主機名稱。

• pid (Optional[int]) – 節點的程序 ID。

• master_endpoint (str) – rendezvous 儲存的主節點端點 (如果已知)。

• local_id (Optional[int]) – 節點的 local_id (如果在 dynamic_rendezvous.py 中定義)。

• rank (Optional[int]) – 節點的 rank (如果已知)。

回傳

None

回傳型別

None

範例

>>> # See DynamicRendezvousHandler class
>>> def _record(
...     self,
...     message: str,
...     node_state: NodeState = NodeState.RUNNING,
...     rank: Optional[int] = None,
... ) -> None:
...     construct_and_record_rdzv_event(
...         name=f"{self.__class__.__name__}.{get_method_name()}",
...         run_id=self._settings.run_id,
...         message=message,
...         node_state=node_state,
...         hostname=self._this_node.addr,
...         pid=self._this_node.pid,
...         local_id=self._this_node.local_id,
...         rank=rank,
...     )

torch.distributed.elastic.events.get_logging_handler(destination='null')

回傳型別

處理器

事件物件

class torch.distributed.elastic.events.api.Event(name, source, timestamp=0, metadata=<factory>)

此類別代表在 torchelastic 工作執行期間發生的通用事件。

事件可以是任何有意義的動作。

參數

• name (str) – 事件名稱。

• source (EventSource) – 事件產生者，例如：agent 或 worker。

• timestamp (int) – 事件發生時的時間戳記 (毫秒)。

• metadata (Dict[str, Optional[Union[str, int, float, bool]]]) – 與事件關聯的其他資料。

class torch.distributed.elastic.events.api.EventSource(value)

事件產生者的已知識別符號。

torch.distributed.elastic.events.api.EventMetadataValue

是 Optional[Union[str, int, float, bool]] 的別名