Skip to content

OptimizerEmbeddingTokens metric

Bases: EmbeddingModelOptimizersOperationalMetric

Tokens consumed by embedding calls during the optimizer step.

Example:

program.compile(
    metrics=[
        synalinks.metrics.OptimizerEmbeddingTokens(),
    ],
)
Source code in synalinks/src/metrics/em_metrics.py
@synalinks_export("synalinks.metrics.OptimizerEmbeddingTokens")
class OptimizerEmbeddingTokens(EmbeddingModelOptimizersOperationalMetric):
    """Tokens consumed by embedding calls during the optimizer step.

    Example:

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

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

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