Skip to content

LMOptimizersOperationalMetric metric

Bases: LMOperationalMetric

Base for LM metrics scoped to the optimizer phase.

Reads from each bound LM's optimizer_cumulated_* counters, which the LM populates while Optimizer.optimize is running (but not while nested reward computation is in progress; those go to the rewards bucket).

Example:

program.compile(
    metrics=[
        synalinks.metrics.LMOptimizersOperationalMetric(),
    ],
)
Source code in synalinks/src/metrics/lm_metrics.py
@synalinks_export(
    [
        "synalinks.metrics.LMOptimizersOperationalMetric",
        "synalinks.LMOptimizersOperationalMetric",
    ]
)
class LMOptimizersOperationalMetric(LMOperationalMetric):
    """Base for LM metrics scoped to the optimizer phase.

    Reads from each bound LM's `optimizer_cumulated_*` counters, which
    the LM populates while `Optimizer.optimize` is running (but not
    while nested reward computation is in progress; those go to the
    rewards bucket).

    Example:

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

    _phase = "optimizer"