Skip to content

RewardCacheCreationTokens metric

Bases: LMRewardsOperationalMetric

Tokens written to the prompt cache during reward computation.

Example:

program.compile(
    metrics=[
        synalinks.metrics.RewardCacheCreationTokens(),
    ],
)
Source code in synalinks/src/metrics/lm_metrics.py
@synalinks_export("synalinks.metrics.RewardCacheCreationTokens")
class RewardCacheCreationTokens(LMRewardsOperationalMetric):
    """Tokens written to the prompt cache during reward computation.

    Example:

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

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

    def result(self):
        return int(self._delta("cache_creation_tokens"))