rpx_benchmark.tasks.keypoint_matching

Keypoint matching between a pair of RGB frames.

 1"""Keypoint matching between a pair of RGB frames."""
 2
 3from __future__ import annotations
 4
 5from dataclasses import dataclass
 6
 7from ..api import TaskType
 8from ._pipeline import PipelineResult, TaskRunConfig, run_pipeline
 9from .registry import TaskSpec, register_task
10
11PRIMARY_METRIC = "keypoint_acc"
12
13
14@dataclass
15class KeypointMatchingRunConfig(TaskRunConfig):
16    pass
17
18
19def run_keypoint_matching(cfg: KeypointMatchingRunConfig) -> PipelineResult:
20    return run_pipeline(
21        task=TaskType.KEYPOINT_MATCHING,
22        primary_metric=PRIMARY_METRIC,
23        cfg=cfg,
24        compute_ts=False,
25    )
26
27
28TASK_SPEC = TaskSpec(
29    task=TaskType.KEYPOINT_MATCHING,
30    display_name="Keypoint Matching",
31    description="Corresponding points between two RGB frames.",
32    primary_metric=PRIMARY_METRIC,
33    required_modalities=["rgb", "keypoints"],
34    higher_is_better=True,
35    run=run_keypoint_matching,
36)
37
38register_task(TASK_SPEC)
PRIMARY_METRIC = 'keypoint_acc'
@dataclass
class KeypointMatchingRunConfig(rpx_benchmark.tasks._pipeline.TaskRunConfig): 
15@dataclass
16class KeypointMatchingRunConfig(TaskRunConfig):
17    pass

KeypointMatchingRunConfig(model: 'Optional[BenchmarkableModel]' = None, split: 'Difficulty | str' = , repo_id: 'Optional[str]' = None, cache_dir: 'Optional[str]' = None, revision: 'Optional[str]' = '51432e5d48895bbafb490ae7c5e34e0f6b7da7d6', batch_size: 'int' = 1, require_cuda: 'bool' = False, skip_flops: 'bool' = False, max_samples: 'Optional[int]' = None, manifest_path: 'Optional[str]' = None, device: 'str' = 'cuda', output_dir: 'Optional[str]' = None, progress: 'Optional[ProgressCallback]' = None, metric_suite: 'Optional[MetricSuite]' = None, upload_to_box: 'bool' = False, box_folder_id: 'Optional[str]' = None)

KeypointMatchingRunConfig( model: Optional[rpx_benchmark.adapters.BenchmarkableModel] = None, split: rpx_benchmark.api.Difficulty | str = <Difficulty.HARD: 'hard'>, repo_id: Optional[str] = None, cache_dir: Optional[str] = None, revision: Optional[str] = '51432e5d48895bbafb490ae7c5e34e0f6b7da7d6', batch_size: int = 1, require_cuda: bool = False, skip_flops: bool = False, max_samples: Optional[int] = None, manifest_path: Optional[str] = None, device: str = 'cuda', output_dir: Optional[str] = None, progress: Optional[Callable[[int, Optional[int], str], NoneType]] = None, metric_suite: Optional[rpx_benchmark.metrics.MetricSuite] = None, upload_to_box: bool = False, box_folder_id: Optional[str] = None)
Inherited Members
rpx_benchmark.tasks._pipeline.TaskRunConfig
model
split
repo_id
cache_dir
revision
batch_size
require_cuda
skip_flops
max_samples
manifest_path
device
output_dir
progress
metric_suite
upload_to_box
box_folder_id
def run_keypoint_matching( cfg: KeypointMatchingRunConfig) -> Tuple[rpx_benchmark.metrics.registry.BenchmarkResult, rpx_benchmark.deployment.DeploymentReadinessReport, Dict[str, pathlib.Path]]: 
20def run_keypoint_matching(cfg: KeypointMatchingRunConfig) -> PipelineResult:
21    return run_pipeline(
22        task=TaskType.KEYPOINT_MATCHING,
23        primary_metric=PRIMARY_METRIC,
24        cfg=cfg,
25        compute_ts=False,
26    )
TASK_SPEC = TaskSpec(task=<TaskType.KEYPOINT_MATCHING: 'keypoint_matching'>, display_name='Keypoint Matching', primary_metric='keypoint_acc', required_modalities=['rgb', 'keypoints'], run=<function run_keypoint_matching>, higher_is_better=True, description='Corresponding points between two RGB frames.', temporal_stability_fn=None, geometric_coherence_fn=None)