---
title: metric
---

<div class="python-reference">
<a id="fastvideo.eval.metrics.vbench.subject_consistency.metric-classes"></a>
<a id="fastvideo.eval.metrics.vbench.subject_consistency.metric-functions"></a>
<a id="fastvideo.eval.metrics.vbench.subject_consistency.metric"></a>
<p>VBench Subject Consistency — DINO ViT-B/16 temporal feature similarity.</p>
<p>Measures how well the main subject maintains its appearance throughout
the video via cosine similarity of DINO features between consecutive
frames and the first frame.</p>
<h2 id="fastvideo.eval.metrics.vbench.subject_consistency.metric.BaseMetric"><code>fastvideo.eval.metrics.vbench.subject_consistency.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.subject_consistency.metric.BaseMetric.to"><code>fastvideo.eval.metrics.vbench.subject_consistency.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.subject_consistency.metric.BaseMetric.setup"><code>fastvideo.eval.metrics.vbench.subject_consistency.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.subject_consistency.metric.BaseMetric.compute"><code>fastvideo.eval.metrics.vbench.subject_consistency.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.subject_consistency.metric.BaseMetric.reset"><code>fastvideo.eval.metrics.vbench.subject_consistency.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.subject_consistency.metric.BaseMetric.accumulate"><code>fastvideo.eval.metrics.vbench.subject_consistency.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.subject_consistency.metric.BaseMetric.finalize"><code>fastvideo.eval.metrics.vbench.subject_consistency.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.subject_consistency.metric.BaseMetric.merge_from"><code>fastvideo.eval.metrics.vbench.subject_consistency.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.subject_consistency.metric.register"><code>fastvideo.eval.metrics.vbench.subject_consistency.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.subject_consistency.metric.MetricResult"><code>fastvideo.eval.metrics.vbench.subject_consistency.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.subject_consistency.metric.consistency_score"><code>fastvideo.eval.metrics.vbench.subject_consistency.metric.consistency_score</code></h2>
<pre class="doc-signature"><code>consistency_score(features: torch.Tensor) -&gt; float</code></pre>
<p>VBench-style temporal consistency from (T, D) L2-normalized features.</p>
<p>For each frame t &gt; 0, computes:
    sim = (cos(f[t], f[t-1]) + cos(f[t], f[0])) / 2, clamped &gt;= 0</p>
<p>Returns the mean similarity across all t &gt; 0.</p>
<h2 id="fastvideo.eval.metrics.vbench.subject_consistency.metric.SubjectConsistencyMetric"><code>fastvideo.eval.metrics.vbench.subject_consistency.metric.SubjectConsistencyMetric</code></h2>
<pre class="doc-signature"><code>SubjectConsistencyMetric()</code></pre>


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

    name = &quot;vbench.subject_consistency&quot;
    requires_reference = False
    higher_is_better = True
    needs_gpu = True
    backbone = &quot;dino_vitb16&quot;

    def __init__(self) -&gt; None:
        super().__init__()
        self._model: Any = None

    def to(self, device):
        super().to(device)
        if self._model is not None:
            self._model = self._model.to(self.device)
        return self

    def setup(self) -&gt; None:
        if self._model is not None:
            return
        model = torch.hub.load(&quot;facebookresearch/dino:main&quot;, &quot;dino_vitb16&quot;)
        model.to(self.device)
        model.eval()
        self._model = model

    @torch.no_grad()
    def compute(self, sample: dict) -&gt; MetricResult:
        video = sample&#91;&quot;video&quot;&#93;  # (T, C, H, W)
        frames = video.to(self.device)
        # antialias=False matches VBench&#x27;s dino_transform (vbench/utils.py:50)
        frames = resize(frames, 224, antialias=False)
        frames = normalize(frames, mean=_MEAN, std=_STD)

        chunk = self._chunk_size or 64
        feats = &#91;&#93;
        for i in range(0, frames.shape&#91;0&#93;, chunk):
            f = self._model(frames&#91;i:i + chunk&#93;)
            f = F.normalize(f, dim=-1, p=2)
            feats.append(f)
        all_feats = torch.cat(feats, dim=0)  # (T, D)
        return MetricResult(
            name=self.name,
            score=consistency_score(all_feats),
            details=&#123;&#125;,
        )</code></pre></details>
<h3 id="fastvideo.eval.metrics.vbench.subject_consistency.metric.SubjectConsistencyMetric.to"><code>fastvideo.eval.metrics.vbench.subject_consistency.metric.SubjectConsistencyMetric.to</code></h3>
<pre class="doc-signature"><code>to(device)</code></pre>

<details><summary>Source</summary><pre><code>def to(self, device):
    super().to(device)
    if self._model is not None:
        self._model = self._model.to(self.device)
    return self</code></pre></details>
<h3 id="fastvideo.eval.metrics.vbench.subject_consistency.metric.SubjectConsistencyMetric.setup"><code>fastvideo.eval.metrics.vbench.subject_consistency.metric.SubjectConsistencyMetric.setup</code></h3>
<pre class="doc-signature"><code>setup() -&gt; None</code></pre>

<details><summary>Source</summary><pre><code>def setup(self) -&gt; None:
    if self._model is not None:
        return
    model = torch.hub.load(&quot;facebookresearch/dino:main&quot;, &quot;dino_vitb16&quot;)
    model.to(self.device)
    model.eval()
    self._model = model</code></pre></details>
<h3 id="fastvideo.eval.metrics.vbench.subject_consistency.metric.SubjectConsistencyMetric.compute"><code>fastvideo.eval.metrics.vbench.subject_consistency.metric.SubjectConsistencyMetric.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)
    frames = video.to(self.device)
    # antialias=False matches VBench&#x27;s dino_transform (vbench/utils.py:50)
    frames = resize(frames, 224, antialias=False)
    frames = normalize(frames, mean=_MEAN, std=_STD)

    chunk = self._chunk_size or 64
    feats = &#91;&#93;
    for i in range(0, frames.shape&#91;0&#93;, chunk):
        f = self._model(frames&#91;i:i + chunk&#93;)
        f = F.normalize(f, dim=-1, p=2)
        feats.append(f)
    all_feats = torch.cat(feats, dim=0)  # (T, D)
    return MetricResult(
        name=self.name,
        score=consistency_score(all_feats),
        details=&#123;&#125;,
    )</code></pre></details>
</div>
