Skip to content

OptimizerTokensPerSecond metric

Bases: LMOptimizersOperationalMetric

Throughput in tokens per second during the optimizer step.

Example:

program.compile(
    metrics=[
        synalinks.metrics.OptimizerTokensPerSecond(),
    ],
)
Source code in synalinks/src/metrics/lm_metrics.py
@synalinks_export("synalinks.metrics.OptimizerTokensPerSecond")
class OptimizerTokensPerSecond(LMOptimizersOperationalMetric):
    """Throughput in tokens per second during the optimizer step.

    Example:

    ```python
    program.compile(
        metrics=[
            synalinks.metrics.OptimizerTokensPerSecond(),
        ],
    )
    ```
    """

    def __init__(self, name="optimizer_tokens_per_second"):
        super().__init__(name=name)

    def result(self):
        wall = self._wall_clock_delta()
        if wall <= 0.0:
            return 0.0
        return self._delta("tokens") / wall