跳转至

ztxexp.tracking.base

ztxexp.tracking.base

追踪器协议定义。

Tracker

Bases: Protocol

实验追踪器协议。

所有追踪器都应实现生命周期三段回调: 1. run 开始; 2. 指标事件; 3. run 结束。

源代码位于: ztxexp/tracking/base.py
class Tracker(Protocol):
    """实验追踪器协议。

    所有追踪器都应实现生命周期三段回调:
    1. run 开始;
    2. 指标事件;
    3. run 结束。
    """

    def on_run_start(self, ctx: RunContext, meta: RunMetadata) -> None:
        """run 启动回调。"""

    def on_metric(self, ctx: RunContext, event: MetricEvent) -> None:
        """指标事件回调。"""

    def on_run_end(self, ctx: RunContext, summary: dict[str, object]) -> None:
        """run 结束回调。"""

on_metric

on_metric(ctx: RunContext, event: MetricEvent) -> None

指标事件回调。

源代码位于: ztxexp/tracking/base.py
def on_metric(self, ctx: RunContext, event: MetricEvent) -> None:
    """指标事件回调。"""

on_run_end

on_run_end(ctx: RunContext, summary: dict[str, object]) -> None

run 结束回调。

源代码位于: ztxexp/tracking/base.py
def on_run_end(self, ctx: RunContext, summary: dict[str, object]) -> None:
    """run 结束回调。"""

on_run_start

on_run_start(ctx: RunContext, meta: RunMetadata) -> None

run 启动回调。

源代码位于: ztxexp/tracking/base.py
def on_run_start(self, ctx: RunContext, meta: RunMetadata) -> None:
    """run 启动回调。"""