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.

Tác vụ
optical flow
Kích thước
s, l at 640 px
Cài đặt
pip install libreyolo
Bậc hỗ trợ
Chỉ suy luận, từ v1.8.0. Chỉ dự đoán, kiểm định và xuất. Không áp dụng các tính năng huấn luyện.
Thượng nguồn
UniMatch của Autonomous Vision Group (University of Tübingen), MIT. Bài báo, mã nguồn
Giấy phép
Mã nguồn MIT, trọng số MIT. Sử dụng thương mại

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

Tác vụONNXTorchScriptExecuTorchTensorRTOpenVINOPaddleMNNRKNNAxelerancnnTFLiteCoreMLCore AI
Optical flowOptical flow to ONNX: không được hỗ trợOptical flow to TorchScript: không được hỗ trợOptical flow to ExecuTorch: không được hỗ trợOptical flow to TensorRT: không được hỗ trợOptical flow to OpenVINO: không được hỗ trợOptical flow to Paddle: không được hỗ trợOptical flow to MNN: không được hỗ trợOptical flow to RKNN: không được hỗ trợOptical flow to Axelera: không được hỗ trợOptical flow to ncnn: không được hỗ trợOptical flow to TFLite: không được hỗ trợOptical flow to CoreML: không được hỗ trợOptical flow to Core AI: không được hỗ trợ

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.

Mọi tệp ở trên hiện đều có trong tổ chức LibreYOLO và được tải xuống trong lần sử dụng đầu tiên.

Licensing

Hãy kiểm tra giấy phép trong repo Hugging Face của trọng số cụ thể mà bạn tải xuống. Mỗi checkpoint trong tổ chức LibreYOLO đều có giấy phép riêng và giấy phép có thể khác nhau trong cùng một họ. Repo đó là nguồn có thẩm quyền; phần tóm tắt dưới đây mô tả các điều khoản áp dụng khi trang này được kiểm chứng lần gần nhất.

Đây là phần mô tả các giấy phép liên quan, không phải tư vấn pháp lý. Nếu câu trả lời có ý nghĩa về mặt thương mại, hãy tự đọc các giấy phép và tham khảo cố vấn của riêng bạn.

Công trình gốc
UniMatch, Autonomous Vision Group (University of Tübingen)
Giấy phép thượng nguồn
MIT
Nguồn thượng nguồn
github.com/autonomousvision/unimatch
Mã nguồn LibreYOLO
MIT
Trọng số
MIT, được phát hành lại tại huggingface.co/LibreYOLO
Diễn giải
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}
}

Được sao chép từ khối trích dẫn của tác giả tại github.com/autonomousvision/unimatch#citation.

Đã kiểm chứng với LibreYOLO v1.8.0. Các bảng hỗ trợ, checkpoint và số liệu benchmark trên trang này được tạo từ thư viện đã phát hành và trọng số đã công bố, không phải viết thủ công.