Skip to content

AvgOptimizerCostPerCall metric

Bases: LMOptimizersOperationalMetric

Average LM-call cost during the optimizer step.

Example:

program.compile(
    metrics=[
        synalinks.metrics.AvgOptimizerCostPerCall(),
    ],
)
Source code in synalinks/src/metrics/lm_metrics.py
@synalinks_export("synalinks.metrics.AvgOptimizerCostPerCall")
class AvgOptimizerCostPerCall(LMOptimizersOperationalMetric):
    """Average LM-call cost during the optimizer step.

    Example:

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

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

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