---
title: metric
---

<div class="python-reference">
<a id="fastvideo.eval.metrics.vbench.multiple_objects.metric-classes"></a>
<a id="fastvideo.eval.metrics.vbench.multiple_objects.metric-functions"></a>
<a id="fastvideo.eval.metrics.vbench.multiple_objects.metric"></a>
<p>VBench Multiple Objects — GRiT detection for dual-object presence.</p>
<p>Checks if BOTH target objects are detected in each of 16 sampled frames.
Score = matching_frames / total_frames.</p>
<h2 id="fastvideo.eval.metrics.vbench.multiple_objects.metric.BaseMetric"><code>fastvideo.eval.metrics.vbench.multiple_objects.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.multiple_objects.metric.BaseMetric.to"><code>fastvideo.eval.metrics.vbench.multiple_objects.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.multiple_objects.metric.BaseMetric.setup"><code>fastvideo.eval.metrics.vbench.multiple_objects.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.multiple_objects.metric.BaseMetric.compute"><code>fastvideo.eval.metrics.vbench.multiple_objects.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.multiple_objects.metric.BaseMetric.reset"><code>fastvideo.eval.metrics.vbench.multiple_objects.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.multiple_objects.metric.BaseMetric.accumulate"><code>fastvideo.eval.metrics.vbench.multiple_objects.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.multiple_objects.metric.BaseMetric.finalize"><code>fastvideo.eval.metrics.vbench.multiple_objects.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.multiple_objects.metric.BaseMetric.merge_from"><code>fastvideo.eval.metrics.vbench.multiple_objects.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.multiple_objects.metric.register"><code>fastvideo.eval.metrics.vbench.multiple_objects.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.multiple_objects.metric.MetricResult"><code>fastvideo.eval.metrics.vbench.multiple_objects.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.multiple_objects.metric.MultipleObjectsMetric"><code>fastvideo.eval.metrics.vbench.multiple_objects.metric.MultipleObjectsMetric</code></h2>
<pre class="doc-signature"><code>MultipleObjectsMetric()</code></pre>


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

    name = &quot;vbench.multiple_objects&quot;
    requires_reference = False
    higher_is_better = True
    needs_gpu = True
    dependencies = &#91;&quot;detectron2&quot;&#93;

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

    def setup(self) -&gt; None:
        if self._model is not None:
            return
        from fastvideo.eval.metrics.vbench._grit_helper import load_grit_model
        # VBench&#x27;s multiple_objects uses ObjectDet head
        self._model = load_grit_model(self.device, task=&quot;ObjectDet&quot;)

    @torch.no_grad()
    def compute(self, sample: dict) -&gt; MetricResult:
        from fastvideo.eval.metrics.vbench._grit_helper import prepare_frames, detect_frames

        video = sample&#91;&quot;video&quot;&#93;  # (T, C, H, W)
        aux = sample.get(&quot;auxiliary_info&quot;) or &#123;&#125;
        if &quot;object&quot; not in aux:
            return self._skip(sample, &quot;missing &#x27;object&#x27; in auxiliary_info&quot;)

        object_info = aux&#91;&quot;object&quot;&#93;
        if &quot; and &quot; not in object_info:
            # multiple_objects expects &quot;&lt;a&gt; and &lt;b&gt;&quot;; single objects are
            # the object_class metric&#x27;s territory — skip this row.
            return self._skip(sample, &quot;&#x27;object&#x27; lacks &#x27; and &#x27; separator&quot;)
        key_a, key_b = &#91;k.strip() for k in object_info.split(&quot; and &quot;)&#93;

        frames_np = prepare_frames(video)
        preds = detect_frames(self._model, frames_np)

        matching = 0
        for frame_pred in preds:
            try:
                obj_set = set(frame_pred&#91;0&#93;&#91;2&#93;) if frame_pred else set()
            except (IndexError, TypeError):
                obj_set = set()
            if key_a in obj_set and key_b in obj_set:
                matching += 1

        total = len(preds)
        score = matching / total if total &gt; 0 else 0.0
        return MetricResult(
            name=self.name,
            score=float(score),
            details=&#123;
                &quot;matching_frames&quot;: matching,
                &quot;total_frames&quot;: total
            &#125;,
        )</code></pre></details>
<h3 id="fastvideo.eval.metrics.vbench.multiple_objects.metric.MultipleObjectsMetric.setup"><code>fastvideo.eval.metrics.vbench.multiple_objects.metric.MultipleObjectsMetric.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
    from fastvideo.eval.metrics.vbench._grit_helper import load_grit_model
    # VBench&#x27;s multiple_objects uses ObjectDet head
    self._model = load_grit_model(self.device, task=&quot;ObjectDet&quot;)</code></pre></details>
<h3 id="fastvideo.eval.metrics.vbench.multiple_objects.metric.MultipleObjectsMetric.compute"><code>fastvideo.eval.metrics.vbench.multiple_objects.metric.MultipleObjectsMetric.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:
    from fastvideo.eval.metrics.vbench._grit_helper import prepare_frames, detect_frames

    video = sample&#91;&quot;video&quot;&#93;  # (T, C, H, W)
    aux = sample.get(&quot;auxiliary_info&quot;) or &#123;&#125;
    if &quot;object&quot; not in aux:
        return self._skip(sample, &quot;missing &#x27;object&#x27; in auxiliary_info&quot;)

    object_info = aux&#91;&quot;object&quot;&#93;
    if &quot; and &quot; not in object_info:
        # multiple_objects expects &quot;&lt;a&gt; and &lt;b&gt;&quot;; single objects are
        # the object_class metric&#x27;s territory — skip this row.
        return self._skip(sample, &quot;&#x27;object&#x27; lacks &#x27; and &#x27; separator&quot;)
    key_a, key_b = &#91;k.strip() for k in object_info.split(&quot; and &quot;)&#93;

    frames_np = prepare_frames(video)
    preds = detect_frames(self._model, frames_np)

    matching = 0
    for frame_pred in preds:
        try:
            obj_set = set(frame_pred&#91;0&#93;&#91;2&#93;) if frame_pred else set()
        except (IndexError, TypeError):
            obj_set = set()
        if key_a in obj_set and key_b in obj_set:
            matching += 1

    total = len(preds)
    score = matching / total if total &gt; 0 else 0.0
    return MetricResult(
        name=self.name,
        score=float(score),
        details=&#123;
            &quot;matching_frames&quot;: matching,
            &quot;total_frames&quot;: total
        &#125;,
    )</code></pre></details>
</div>
