Skip to content

AvgRewardOutputTokensPerCall metric

Bases: LMRewardsOperationalMetric

Average output tokens per LM call during reward computation.

Example:

program.compile(
    metrics=[
        synalinks.metrics.AvgRewardOutputTokensPerCall(),
    ],
)
Source code in synalinks/src/metrics/lm_metrics.py
@synalinks_export("synalinks.metrics.AvgRewardOutputTokensPerCall")
class AvgRewardOutputTokensPerCall(LMRewardsOperationalMetric):
    """Average output tokens per LM call during reward computation.

    Example:

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

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

    def result(self):
        calls = self._delta("calls")
        if calls <= 0:
            return 0.0
        return self._delta("completion_tokens") / calls