UniMatch

UniMatch unifies optical flow, stereo and depth estimation with one transformer matcher (TPAMI 2023); GMFlow is its flow model. LibreYOLO ships the optical flow task with the GMFlow checkpoints, under MIT.

Задачі
optical flow
Розміри
s, l at 640 px
Встановлення
pip install libreyolo
Рівень підтримки
Лише інференс, починаючи з v1.8.0. Лише передбачення, валідація та експорт. Функції навчання не застосовуються.
Першоджерело
UniMatch, автори: Autonomous Vision Group (University of Tübingen), ліцензія MIT. Стаття, джерело
Ліцензії
Код: MIT, ваги: MIT. Комерційне використання

GMFlow treats optical flow as a global matching problem: a transformer compares features of the two frames and a softmax over all positions gives the match, optionally refined by local regression. The vendored upstream code also contains the stereo and depth paths, but only flow is wired in LibreYOLO. Pick l for real-world footage, as upstream recommends.

Install

UniMatch needs no optional extra. Everything it imports is in the base install.

bash
pip install libreyolo

Predict

Weights download from the LibreYOLO Hugging Face organization on first use. The class LibreUniMatch is also exported from libreyolo if you prefer to build the model directly.

Python
from libreyolo import LibreYOLO model = LibreYOLO("LibreUniMatchl-flow.pt")   # weights download on first useresults = model(["frame_0001.jpg", "frame_0002.jpg"]) flow = results[0].flowprint(flow.data.shape)        # (H, W, 2) float32, (dx, dy) in pixelsprint(flow.mean_magnitude)    # mean displacement in pixels
Video
from libreyolo import LibreYOLO model = LibreYOLO("LibreUniMatchl-flow.pt") # N frames give N - 1 results; result i is the flow from frame i to i + 1.for result in model("video.mp4", stream=True, save=True, save_flow=True):    print(result.flow.max_magnitude)
CLI
libreyolo predict model=LibreUniMatchl-flow.pt source=frame_0001.jpg,frame_0002.jpg save=truelibreyolo predict model=LibreUniMatchl-flow.pt source=video.mp4 save=true arrows=true save_flow=true

Flow needs at least two frames: a single image raises. A list of images, a directory sorted by name, a video or a stream is one sequence, and N frames give N - 1 results. result.flow is a FlowField with an (H, W, 2) float32 array on the original canvas of the first frame; flow.data[y, x] is (dx, dy) in pixels, +x right and +y down. UniMatch fills no confidence map, so flow.confidence is None. result.boxes is None. save=True writes the Middlebury colour wheel, arrows=True or warp=True pick the other views, and save_flow=True also writes each pair's raw field as a .flo file. The optical flow task page describes the payload and views in full.

Variants

SizeUpstream checkpointFile
sgmflow-scale1-things: global matching at 1/8 (Chairs, then Things)LibreUniMatchs-flow.pt
lgmflow-scale2-regrefine6-mixdata: GMFlow+ at two scales with 6 refinement steps (canonical)LibreUniMatchl-flow.pt
lSintel fine-tuneLibreUniMatchl-flow-sintel.pt
lKITTI-2015 fine-tuneLibreUniMatchl-flow-kitti.pt

Only l has Sintel and KITTI fine-tunes. LibreUniMatch defaults to size l. Preprocessing reproduces upstream inference_flow: portrait frames are transposed to landscape, and both frames are resized so each side rounds up to the size's padding factor (16 for s, 32 for l). The field is resized back and its vectors rescaled. One deliberate fix over upstream: for portrait frames upstream leaves dx and dy exchanged after transposing back; LibreYOLO swaps them so the field follows the flow contract.

Training is not offered: train() raises NotImplementedError.

Validate

val() runs the shared flow validator on a flow dataset (frames per sequence folder, Middlebury .flo, KITTI 16-bit PNG or .npy ground truth; see the dataset format). It reports the mean end-point error metrics/epe, metrics/px1 and metrics/px3 (share of valid pixels under 1 and 3 px of error) and the KITTI outlier rate metrics/fl_all.

Python
from libreyolo import LibreYOLO model = LibreYOLO("LibreUniMatchl-flow.pt")metrics = model.val(data="my_flow.yaml") print(metrics["metrics/epe"])      # mean end-point error, pixelsprint(metrics["metrics/px1"])      # share of pixels under 1 px errorprint(metrics["metrics/fl_all"])   # KITTI outlier rate
CLI
libreyolo val model=LibreUniMatchl-flow.pt data=my_flow.yaml

Export

ЗадачаONNXTorchScriptExecuTorchTensorRTOpenVINOPaddleMNNRKNNAxelerancnnTFLiteCoreMLCore AI
Optical flowOptical flow to ONNX: не підтримуєтьсяOptical flow to TorchScript: не підтримуєтьсяOptical flow to ExecuTorch: не підтримуєтьсяOptical flow to TensorRT: не підтримуєтьсяOptical flow to OpenVINO: не підтримуєтьсяOptical flow to Paddle: не підтримуєтьсяOptical flow to MNN: не підтримуєтьсяOptical flow to RKNN: не підтримуєтьсяOptical flow to Axelera: не підтримуєтьсяOptical flow to ncnn: не підтримуєтьсяOptical flow to TFLite: не підтримуєтьсяOptical flow to CoreML: не підтримуєтьсяOptical flow to Core AI: не підтримується

Export is not available yet for any format. Optical flow export is blocked until the two-input graph (image1, image2) and the backend vector-rescale contract of the flow task are implemented for a family.

Checkpoints

Every published weight file for this family.

Кожен наведений вище файл уже доступний у організації LibreYOLO і завантажується під час першого використання.

Licensing

Перевіряйте ліцензію в репозиторії Hugging Face конкретних ваг, які завантажуєте. Кожна контрольна точка в організації LibreYOLO має ліцензію, і вона не завжди однакова для всього сімейства. Цей репозиторій є авторитетним джерелом, а наведене нижче резюме описує умови на момент останньої перевірки сторінки.

Це опис відповідних ліцензій, а не юридична консультація. Якщо відповідь має комерційне значення, самостійно прочитайте ліцензії та зверніться по юридичну консультацію.

Оригінальна робота
UniMatch, Autonomous Vision Group (University of Tübingen)
Ліцензія першоджерела
MIT
Джерело першоджерела
github.com/autonomousvision/unimatch
Код LibreYOLO
MIT
Ваги
MIT, повторно опубліковано на huggingface.co/LibreYOLO
Тлумачення
MIT is a permissive license: the code and weights can be used in commercial and closed-source products, provided the copyright and license notice travel with copies. The upstream unimatch/ package at commit 943a9900 is vendored verbatim under libreyolo/models/unimatch/_vendor/ with its MIT LICENSE; LibreYOLO's wrapper code is also MIT. Upstream publishes the GMFlow checkpoints (gmflow-scale1-things as s, gmflow-scale2-regrefine6-mixdata as l, plus its Sintel and KITTI-2015 fine-tunes) without a separate weight license, so LibreYOLO hosts them on its Hugging Face org under the releasing project's MIT license: an implied grant, disclosed as LibreYOLO's interpretation and not confirmed by the publisher. No gating; only the optical flow task is wired, and training is out of scope.

UniMatch is the work of the Autonomous Vision Group (University of Tübingen). The upstream unimatch package is vendored verbatim under its MIT licence. Upstream publishes the GMFlow checkpoints without a separate weight licence, so LibreYOLO hosts them under the releasing project's MIT licence: an implied grant, LibreYOLO's interpretation and not confirmed by the publisher. No gating. MIT allows commercial and closed-source use as long as the copyright and licence notice travel with copies.

Citation

@article{xu2023unifying,
  title={Unifying Flow, Stereo and Depth Estimation},
  author={Xu, Haofei and Zhang, Jing and Cai, Jianfei and Rezatofighi, Hamid and Yu, Fisher and Tao, Dacheng and Geiger, Andreas},
  journal={IEEE Transactions on Pattern Analysis and Machine Intelligence},
  year={2023}
}

Скопійовано з блоку цитування авторів на сторінці github.com/autonomousvision/unimatch#citation.

Перевірено з LibreYOLO v1.8.0. Таблиці підтримки, контрольні точки й результати бенчмарків на цій сторінці згенеровано з випущеної бібліотеки та опублікованих ваг, а не написано вручну.