Skip to content

OptimizerEmbeddingFailedCalls metric

Bases: EmbeddingModelOptimizersOperationalMetric

Embedding calls that failed during the optimizer step.

Example:

program.compile(
    metrics=[
        synalinks.metrics.OptimizerEmbeddingFailedCalls(),
    ],
)
Source code in synalinks/src/metrics/em_metrics.py
@synalinks_export("synalinks.metrics.OptimizerEmbeddingFailedCalls")
class OptimizerEmbeddingFailedCalls(EmbeddingModelOptimizersOperationalMetric):
    """Embedding calls that failed during the optimizer step.

    Example:

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

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

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