API reference
The complete, always-current API reference is generated directly from the unitrack source with griffe: every public symbol, signature, and docstring, grouped by subpackage.
API reference
The complete, always-current API reference is generated directly from the
unitrack source with griffe:
every public symbol, signature, and docstring, grouped by subpackage.
Subpackages
| Subpackage | What's in it |
|---|---|
unitrack.assignment | Linear assignment solvers (Hungarian, Jonker-Volgenant, auction, greedy, soft Sinkhorn) |
unitrack.benchmarks | Benchmark harnesses |
unitrack.costs | Pairwise cost producers |
unitrack.data | Typed records (Detections, Tracklets, FrameContext) |
unitrack.gates | Candidate-pair gating |
unitrack.lifecycle | Track lifecycle policies |
unitrack.pipeline | The typed stage tree that wires stages together |
unitrack.states | Per-feature state recipes |
unitrack.tracker | The Tracker core |
Unitrack — image-trained video tracking primitives.
- assignmentLinear-assignment problem (LAP) solvers over a cost matrix.
- assignment.associateAssociate — bridges a CostExpression to a hard assignment.
- assignment.clip_associateClipAssociator abstract base — extension point for clip-global solvers.
- assignment.lapCUDA LAP solvers backed by :mod:`torchmatch.assignment`.
- assignment.lapjvCPU LAP solvers backed by :mod:`torchmatch.assignment`.
- benchmarksBenchmark harnesses for unitrack (not part of the core import surface).
- benchmarks.hotaHOTA model-benchmark harness.
- benchmarks.hota.datasetsDataset adapters. The first is cityscapes-dvps from a local LMDB.
- benchmarks.hota.learned_modulesLearned MOTR-style appearance-filter modules.
- benchmarks.hota.metricWrap the evaluators panoptic_tracking() preset as a streaming runner.
- benchmarks.hota.modelsHuggingFace panoptic-segmentation model adapters.
- benchmarks.hota.protocolsStructural protocols for the three harness plug points.
- benchmarks.hota.renderRender tracker output into an evaluators-compatible panoptic map.
- benchmarks.hota.reportMarkdown + JSON writers for benchmark results.
- benchmarks.hota.runnerSweep models x sequences, streaming predictions into the HOTA metric.
- benchmarks.hota.trackerTracker factories (mask-IoU, cosine, cascade, Kalman) + a registry.
- benchmarks.hota.train_learnedTrain the learned MOTR-style appearance filter and write its checkpoint.
- benchmarks.hota.typesPlain data carriers exchanged between the harness plug points.
- costsCost producers and cost-side combinators.
- costs.combinatorsCost-side combinators: :class:`Weighted`, :class:`Reduce`, :class:`Sinkhorn`.
- costs.distanceDistance-based :class:`~unitrack.pipeline.CostProducer` leaves.
- costs.galleryGallery (feature-bank) cost — match a detection against a tracklet's history.
- costs.overlapIoU-family :class:`~unitrack.pipeline.CostProducer` leaves.
- dataTyped records carried by the stage tree.
- data.clipClip-aware records: sequences of per-frame detections and tracklets.
- data.costCost matrix with un-applied gate attachments.
- data.detectionsTyped record of one frame's new detections.
- data.framePer-frame timing and stream metadata.
- data.gateAlgebraic ``Gate`` variant: ``PerPair``, ``PerCs``, ``PerDs``, ``CostBias``.
- data.matchResult of running a stage tree to assignment.
- data.tensor_specTyped tensor shape and dtype declaration used by State schemas.
- data.trackletsTyped snapshot of all tracked identities at a frame.
- gatesGates layer.
- gates.motionMahalanobis (χ²) motion gate using Kalman state covariance.
- gates.simpleBuilt-in gates: NoneGate, ClassGate, ScoreGate.
- gates.softSoft companions for gates.
- gates.spatialSpatial-distance gates.
- lifecycleLifecycle management layer.
- lifecycle.filtersPredicate functions used by the pipeline.Filter combinator.
- lifecycle.policiesLifecycle policies.
- lifecycle.softDifferentiable companion to :class:`~unitrack.lifecycle.StandardLifecycle`.
- lifecycle.statusTracklet lifecycle status enum.
- lifecycle.visibilityVisibility policies.
- pipelineStage protocols, combinators, merges, and the hard-to-soft tree rewrite.
- pipeline.baseStage protocols and the construction-time type error.
- pipeline.combinatorsStage-tree combinators.
- pipeline.diffHard-to-soft node-replacement registry for ``differentiable=True``.
- pipeline.mergeMerge strategies for :class:`~unitrack.pipeline.combinators.Parallel`.
- statesState protocols and :class:`~unitrack.states.State` recipes for tracklet fields.
- states.baseState, Process, Observation, and Initializer protocols.
- states.directionalvon Mises-Fisher directional filter for unit-norm embedding states.
- states.emaEMA-family :class:`~unitrack.states.Process` and :class:`Observation` primitives.
- states.galleryGallery (feature-bank) state — keep a ring buffer of recent embeddings.
- states.identityIdentity ``Process``, ``Replace``, and simple ``Initializer`` recipes.
- states.kalmanKalman filter state family for unitrack.
- states.kalman.baseKalmanLinear backbone — generic linear-Gaussian predict step.
- states.kalman.bboxBounding-box Kalman processes — SORT (7-D) and DeepSORT (8-D) variants.
- states.kalman.centroidConstant-velocity centroid Kalman process specializations.
- states.kalman.ensembleEnsemble Kalman filter (deterministic ETKF) for high-dimensional states.
- states.kalman.informationInformation filter — the exact dual of the Kalman filter.
- states.kalman.projectMeasurement-projection and PSD-solve helpers used by Mahalanobis primitives.
- states.kalman.updateKalmanUpdate Observation — Joseph-form update; predict-only on miss.
- states.learnedLearned propagation hooks — a slot for a MOTR-style recurrent update.
- states.softDifferentiable :class:`Observation` companions used under ``differentiable=True``.
- trackerPure tracker, multi-stream/batch wrappers, and clip-level inference.
- tracker.batchMulti-slot tracker wrapper with an optional batched LAP fast path.
- tracker.clipClip-level tracker: per-frame iteration plus optional refiner mode.
- tracker.memoryPer-stream tracker state: current snapshot and the next-ID counter.
- tracker.multistreamPer-key tracker wrapper and fork-policy primitives.
- tracker.trackerPure tracker — step function over :class:`~unitrack.data.Tracklets` snapshots.