Skip to content

InputTokens metric

Bases: LMOperationalMetric

Cumulated input (prompt) tokens consumed during this run.

Example:

program.compile(
    metrics=[
        synalinks.metrics.InputTokens(),
    ],
)
Source code in synalinks/src/metrics/lm_metrics.py
@synalinks_export("synalinks.metrics.InputTokens")
class InputTokens(LMOperationalMetric):
    """Cumulated input (prompt) tokens consumed during this run.

    Example:

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

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

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