Skip to content

TokensPerSecond metric

Bases: LMOperationalMetric

Throughput in total tokens per second over this run.

Example:

program.compile(
    metrics=[
        synalinks.metrics.TokensPerSecond(),
    ],
)
Source code in synalinks/src/metrics/lm_metrics.py
@synalinks_export("synalinks.metrics.TokensPerSecond")
class TokensPerSecond(LMOperationalMetric):
    """Throughput in total tokens per second over this run.

    Example:

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

    def __init__(self, name="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