Skip to content

AvgEmbeddingVectorsPerCall metric

Bases: EmbeddingModelOperationalMetric

Average vectors (i.e. batch size) per embedding call over this run.

Example:

program.compile(
    metrics=[
        synalinks.metrics.AvgEmbeddingVectorsPerCall(),
    ],
)
Source code in synalinks/src/metrics/em_metrics.py
@synalinks_export("synalinks.metrics.AvgEmbeddingVectorsPerCall")
class AvgEmbeddingVectorsPerCall(EmbeddingModelOperationalMetric):
    """Average vectors (i.e. batch size) per embedding call over this run.

    Example:

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

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

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