---
title: metric
---

<div class="python-reference">
<a id="fastvideo.eval.metrics.vbench.temporal_flickering.metric-classes"></a>
<a id="fastvideo.eval.metrics.vbench.temporal_flickering.metric-functions"></a>
<a id="fastvideo.eval.metrics.vbench.temporal_flickering.metric"></a>
<p>VBench Temporal Flickering — measures frame-to-frame stability.</p>
<p>Score = (255 - mean_MAE) / 255, where MAE is computed between consecutive
frames in uint8 [0, 255] space.  Higher = less flickering.</p>
<h2 id="fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric"><code>fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric</code></h2>
<pre class="doc-signature"><code>BaseMetric()</code></pre>
<p>Abstract base class for all eval metrics.</p>
<p>Two execution shapes:</p>
<ul>
<li>
<p><strong>Per-sample</strong> (<code>is_set_metric=False</code>, default) — implement
  :meth:<code>compute</code>. The Evaluator calls it once per input sample and
  returns one :class:<code>MetricResult</code> per sample.</p>
</li>
<li>
<p><strong>Set-vs-set</strong> (<code>is_set_metric=True</code>) — implement
  :meth:<code>accumulate</code> (called once per sample to buffer features)
  and :meth:<code>finalize</code> (called once after all samples to compute
  the corpus-level result). Use :meth:<code>reset</code> to clear buffers and
  :meth:<code>merge_from</code> to fold multi-GPU per-worker state together.</p>
</li>
</ul>
<p>Optionally override :meth:<code>setup</code> to eagerly load models. Metrics
that chunk along the time dim for memory hardcode their own chunk
size in <code>__init__</code> (see <code>optical_flow</code> for the canonical
example). Eval always processes one video per
:meth:<code>Evaluator.evaluate</code> call; <code>compute</code> / <code>accumulate</code>
receive a single sample, not a batch.</p>

<h3 id="fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.to"><code>fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.to</code></h3>
<pre class="doc-signature"><code>to(device: str | torch.device) -&gt; BaseMetric</code></pre>
<p>Move metric (and its internal models) to <em>device</em>.</p>
<h3 id="fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.setup"><code>fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.setup</code></h3>
<pre class="doc-signature"><code>setup() -&gt; None</code></pre>
<p>Eagerly load models. Called once by :class:<code>EvalWorker</code>.</p>
<p>Default is a no-op; metrics with no eager state (pixel math,
closed-form ops) inherit this. Override only if your metric
needs to load weights.</p>
<h3 id="fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.compute"><code>fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.compute</code></h3>
<pre class="doc-signature"><code>compute(sample: dict) -&gt; MetricResult</code></pre>
<p>Per-sample metrics: compute the score for one sample.</p>
<p><code>sample["video"]</code> is <code>(T, C, H, W)</code> float in <code>[0, 1]</code>.
<code>sample["reference"]</code> (if used) has the same shape. Return
<code>self._skip(sample, reason)</code> for missing inputs.</p>
<h3 id="fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.reset"><code>fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.reset</code></h3>
<pre class="doc-signature"><code>reset() -&gt; None</code></pre>
<p>Clear accumulator state at the start of each evaluate() call.</p>
<h3 id="fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.accumulate"><code>fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.accumulate</code></h3>
<pre class="doc-signature"><code>accumulate(sample: dict) -&gt; None</code></pre>
<p>Buffer per-sample features for a corpus-level metric.</p>
<h3 id="fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.finalize"><code>fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.finalize</code></h3>
<pre class="doc-signature"><code>finalize() -&gt; MetricResult</code></pre>
<p>Compute the corpus-level result from buffered state.</p>
<h3 id="fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.merge_from"><code>fastvideo.eval.metrics.vbench.temporal_flickering.metric.BaseMetric.merge_from</code></h3>
<pre class="doc-signature"><code>merge_from(other: BaseMetric) -&gt; None</code></pre>
<p>Multi-GPU: fold another worker's accumulator state into this one.</p>
<h2 id="fastvideo.eval.metrics.vbench.temporal_flickering.metric.register"><code>fastvideo.eval.metrics.vbench.temporal_flickering.metric.register</code></h2>
<pre class="doc-signature"><code>register(name: str)</code></pre>
<p>Decorator to register a metric class.</p>
<p>Usage::</p>
<pre><code>@register("ssim")
class SSIMMetric(BaseMetric):
    ...
</code></pre>
<h2 id="fastvideo.eval.metrics.vbench.temporal_flickering.metric.MetricResult"><code>fastvideo.eval.metrics.vbench.temporal_flickering.metric.MetricResult</code></h2>
<pre class="doc-signature"><code>MetricResult(name: str, score: float | None, details: dict&#91;str, Any&#93; = dict())</code></pre>
<p>Standard result container returned by all metrics.</p>
<p><code>score</code> is <code>None</code> when the metric was skipped (e.g. missing
required input).  Check <code>details["skipped"]</code> for the reason.</p>

<h2 id="fastvideo.eval.metrics.vbench.temporal_flickering.metric.TemporalFlickeringMetric"><code>fastvideo.eval.metrics.vbench.temporal_flickering.metric.TemporalFlickeringMetric</code></h2>
<pre class="doc-signature"><code>TemporalFlickeringMetric()</code></pre>

<details><summary>Source</summary><pre><code>@register(&quot;vbench.temporal_flickering&quot;)
class TemporalFlickeringMetric(BaseMetric):

    name = &quot;vbench.temporal_flickering&quot;
    requires_reference = False
    higher_is_better = True
    needs_gpu = False

    @torch.no_grad()
    def compute(self, sample: dict) -&gt; MetricResult:
        video = sample&#91;&quot;video&quot;&#93;  # (T, C, H, W) &#91;0, 1&#93;
        T = video.shape&#91;0&#93;
        if T &lt;= 1:
            return MetricResult(name=self.name, score=1.0, details=&#123;&#125;)

        frames = (video * 255.0).to(torch.uint8).cpu().numpy()
        frames = frames.transpose(0, 2, 3, 1).astype(np.float32)
        mae_per_pair = &#91;float(np.mean(np.abs(frames&#91;t&#93; - frames&#91;t + 1&#93;))) for t in range(T - 1)&#93;
        mean_mae = float(np.mean(mae_per_pair))
        return MetricResult(
            name=self.name,
            score=(255.0 - mean_mae) / 255.0,
            details=&#123;&quot;per_pair_mae&quot;: mae_per_pair&#125;,
        )</code></pre></details>
<h3 id="fastvideo.eval.metrics.vbench.temporal_flickering.metric.TemporalFlickeringMetric.compute"><code>fastvideo.eval.metrics.vbench.temporal_flickering.metric.TemporalFlickeringMetric.compute</code></h3>
<pre class="doc-signature"><code>compute(sample: dict) -&gt; MetricResult</code></pre>

<details><summary>Source</summary><pre><code>@torch.no_grad()
def compute(self, sample: dict) -&gt; MetricResult:
    video = sample&#91;&quot;video&quot;&#93;  # (T, C, H, W) &#91;0, 1&#93;
    T = video.shape&#91;0&#93;
    if T &lt;= 1:
        return MetricResult(name=self.name, score=1.0, details=&#123;&#125;)

    frames = (video * 255.0).to(torch.uint8).cpu().numpy()
    frames = frames.transpose(0, 2, 3, 1).astype(np.float32)
    mae_per_pair = &#91;float(np.mean(np.abs(frames&#91;t&#93; - frames&#91;t + 1&#93;))) for t in range(T - 1)&#93;
    mean_mae = float(np.mean(mae_per_pair))
    return MetricResult(
        name=self.name,
        score=(255.0 - mean_mae) / 255.0,
        details=&#123;&quot;per_pair_mae&quot;: mae_per_pair&#125;,
    )</code></pre></details>
</div>
