---
title: metric
---

<div class="python-reference">
<a id="fastvideo.eval.metrics.vbench.aesthetic_quality.metric-classes"></a>
<a id="fastvideo.eval.metrics.vbench.aesthetic_quality.metric-functions"></a>
<a id="fastvideo.eval.metrics.vbench.aesthetic_quality.metric"></a>
<p>VBench Aesthetic Quality — CLIP ViT-L/14 + LAION aesthetic predictor.</p>
<p>Encodes frames through CLIP, passes L2-normalized features through a
linear aesthetic head (768 → 1), and averages scores / 10.</p>
<h2 id="fastvideo.eval.metrics.vbench.aesthetic_quality.metric.BaseMetric"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.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.aesthetic_quality.metric.BaseMetric.to"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.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.aesthetic_quality.metric.BaseMetric.setup"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.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.aesthetic_quality.metric.BaseMetric.compute"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.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.aesthetic_quality.metric.BaseMetric.reset"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.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.aesthetic_quality.metric.BaseMetric.accumulate"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.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.aesthetic_quality.metric.BaseMetric.finalize"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.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.aesthetic_quality.metric.BaseMetric.merge_from"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.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.aesthetic_quality.metric.register"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.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.aesthetic_quality.metric.MetricResult"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.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.aesthetic_quality.metric.AestheticQualityMetric"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.metric.AestheticQualityMetric</code></h2>
<pre class="doc-signature"><code>AestheticQualityMetric()</code></pre>


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

    name = &quot;vbench.aesthetic_quality&quot;
    requires_reference = False
    higher_is_better = True
    needs_gpu = True
    dependencies = &#91;&quot;clip&quot;&#93;
    backbone = &quot;clip_vit_l14&quot;

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

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

    def setup(self) -&gt; None:
        if self._clip_model is not None:
            return

        import clip
        from fastvideo.eval.models import ensure_checkpoint, get_cache_dir
        self._clip_model, _ = clip.load(
            &quot;ViT-L/14&quot;,
            device=self.device,
            download_root=str(get_cache_dir() / &quot;clip&quot;),
        )
        self._clip_model.eval()

        # Load LAION aesthetic head
        ckpt_path = ensure_checkpoint(
            &quot;sa_0_4_vit_l_14_linear.pth&quot;,
            source=_AESTHETIC_URL,
        )
        self._aesthetic_head = nn.Linear(768, 1)
        self._aesthetic_head.load_state_dict(torch.load(ckpt_path, map_location=&quot;cpu&quot;, weights_only=True))
        self._aesthetic_head.to(self.device)
        self._aesthetic_head.eval()

    @torch.no_grad()
    def compute(self, sample: dict) -&gt; MetricResult:
        video = sample&#91;&quot;video&quot;&#93;  # (T, C, H, W)
        frames = _clip_transform(video.to(self.device))

        chunk = self._chunk_size or 32
        scores_list = &#91;&#93;
        for i in range(0, frames.shape&#91;0&#93;, chunk):
            feats = self._clip_model.encode_image(frames&#91;i:i + chunk&#93;).float()
            feats = F.normalize(feats, dim=-1, p=2)
            scores_list.append(self._aesthetic_head(feats).squeeze(-1))

        all_scores = torch.cat(scores_list, dim=0) / 10.0  # (T,)
        return MetricResult(
            name=self.name,
            score=float(all_scores.mean().item()),
            details=&#123;&quot;per_frame&quot;: all_scores.tolist()&#125;,
        )</code></pre></details>
<h3 id="fastvideo.eval.metrics.vbench.aesthetic_quality.metric.AestheticQualityMetric.to"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.metric.AestheticQualityMetric.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._clip_model is not None:
        self._clip_model = self._clip_model.to(self.device)
    if self._aesthetic_head is not None:
        self._aesthetic_head = self._aesthetic_head.to(self.device)
    return self</code></pre></details>
<h3 id="fastvideo.eval.metrics.vbench.aesthetic_quality.metric.AestheticQualityMetric.setup"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.metric.AestheticQualityMetric.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._clip_model is not None:
        return

    import clip
    from fastvideo.eval.models import ensure_checkpoint, get_cache_dir
    self._clip_model, _ = clip.load(
        &quot;ViT-L/14&quot;,
        device=self.device,
        download_root=str(get_cache_dir() / &quot;clip&quot;),
    )
    self._clip_model.eval()

    # Load LAION aesthetic head
    ckpt_path = ensure_checkpoint(
        &quot;sa_0_4_vit_l_14_linear.pth&quot;,
        source=_AESTHETIC_URL,
    )
    self._aesthetic_head = nn.Linear(768, 1)
    self._aesthetic_head.load_state_dict(torch.load(ckpt_path, map_location=&quot;cpu&quot;, weights_only=True))
    self._aesthetic_head.to(self.device)
    self._aesthetic_head.eval()</code></pre></details>
<h3 id="fastvideo.eval.metrics.vbench.aesthetic_quality.metric.AestheticQualityMetric.compute"><code>fastvideo.eval.metrics.vbench.aesthetic_quality.metric.AestheticQualityMetric.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 = _clip_transform(video.to(self.device))

    chunk = self._chunk_size or 32
    scores_list = &#91;&#93;
    for i in range(0, frames.shape&#91;0&#93;, chunk):
        feats = self._clip_model.encode_image(frames&#91;i:i + chunk&#93;).float()
        feats = F.normalize(feats, dim=-1, p=2)
        scores_list.append(self._aesthetic_head(feats).squeeze(-1))

    all_scores = torch.cat(scores_list, dim=0) / 10.0  # (T,)
    return MetricResult(
        name=self.name,
        score=float(all_scores.mean().item()),
        details=&#123;&quot;per_frame&quot;: all_scores.tolist()&#125;,
    )</code></pre></details>
</div>
