RAFT

RAFT is the recurrent all-pairs optical flow network by Teed and Deng (ECCV 2020). It takes two frames and returns, for every pixel of the first, its displacement to the second. LibreYOLO ports the upstream inference code and mirrors the four published checkpoints for the flow task.

Tasks
optical flow
Install
pip install libreyolo
Support tier
Inference only, since v1.8.0. Predict, validate and export only. Training features do not apply.
Upstream
RAFT by Princeton Vision & Learning Lab, BSD-3-Clause. Paper, source
Licenses
Code MIT, weights BSD-3-Clause. Commercial use

RAFT builds a 4D correlation volume between all pixel pairs of the two frames and refines one flow field with a recurrent update block. It is the reference most later flow networks start from, SEA-RAFT, FlowSeek and MEMFOF among them. Pick it when you want the well-known baseline, or the KITTI or Sintel fine-tune for footage close to those benchmarks.

Install

RAFT 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 LibreRAFT is also exported from libreyolo if you prefer to build the model directly.

Python
from libreyolo import LibreYOLO model = LibreYOLO("LibreRAFTl-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("LibreRAFTl-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=LibreRAFTl-flow.pt source=frame_0001.jpg,frame_0002.jpg save=truelibreyolo predict model=LibreRAFTl-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. RAFT 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
sraft-smallLibreRAFTs-flow.pt
lraft-things (canonical)LibreRAFTl-flow.pt
lraft-sintel fine-tuneLibreRAFTl-flow-sintel.pt
lraft-kitti fine-tuneLibreRAFTl-flow-kitti.pt

LibreRAFT defaults to size l. Inference runs at the native frame resolution, padded to a multiple of 8 as upstream's InputPadder does, with a fixed 20 refinement iterations (upstream demo.py). imgsz caps the long side: larger frames are downscaled and the field is scaled back to the original canvas.

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("LibreRAFTl-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=LibreRAFTl-flow.pt data=my_flow.yaml

Export

TaskONNXTorchScriptExecuTorchTensorRTOpenVINOPaddleMNNRKNNAxelerancnnTFLiteCoreMLCore AI
Optical flowOptical flow to ONNX: not supportedOptical flow to TorchScript: not supportedOptical flow to ExecuTorch: not supportedOptical flow to TensorRT: not supportedOptical flow to OpenVINO: not supportedOptical flow to Paddle: not supportedOptical flow to MNN: not supportedOptical flow to RKNN: not supportedOptical flow to Axelera: not supportedOptical flow to ncnn: not supportedOptical flow to TFLite: not supportedOptical flow to CoreML: not supportedOptical flow to Core AI: not supported

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.

FileWeights license
Optical flow
LibreRAFTl-flow.ptbsd-3-clause
LibreRAFTs-flow.ptbsd-3-clause
LibreRAFTl-flow-sintel.ptbsd-3-clause
LibreRAFTl-flow-kitti.ptbsd-3-clause

Every file above exists in the LibreYOLO org today and downloads on first use.

Licensing

Check the license on the Hugging Face repository of the specific weights you download. Every checkpoint in the LibreYOLO org carries one, and they are not always the same across a family. That repository is the authoritative source; the summary below describes what applied when this page was last verified.

This is a description of the licenses involved, not legal advice. If the answer matters commercially, read the licenses yourself and take your own counsel.

Original work
RAFT, Princeton Vision & Learning Lab
Upstream license
BSD-3-Clause
LibreYOLO code
MIT
Weights
BSD-3-Clause, republished at huggingface.co/LibreYOLO
Interpretation
BSD-3-Clause is a permissive license: the code and weights can be used in commercial and closed-source products. Redistributions must keep the copyright notice, the license conditions and the disclaimer, and the authors' names may not be used to endorse derived products without permission. The upstream inference code from princeton-vl/RAFT at commit 2888e15 is vendored under libreyolo/models/raft/_vendor/ with its BSD-3-Clause LICENSE; LibreYOLO's own wrapper code is MIT. The four checkpoints (raft-things as l, raft-small as s, and the raft-sintel and raft-kitti fine-tunes of l) come from the upstream download script and are mirrored on the LibreYOLO Hugging Face org under the same BSD-3-Clause license, without gating. Only the tensors' wrapping changes; training is not offered for this family.

RAFT is the work of Teed and Deng at the Princeton Vision & Learning Lab. The upstream inference code is vendored under its BSD-3-Clause licence, and the four checkpoints from the upstream download script are mirrored on the LibreYOLO Hugging Face organization under the same licence, without gating. BSD-3-Clause allows commercial and closed-source use as long as the copyright notice, conditions and disclaimer are kept.

Citation

@misc{teed2020raftrecurrentallpairsfield,
      title={RAFT: Recurrent All-Pairs Field Transforms for Optical Flow}, 
      author={Zachary Teed and Jia Deng},
      year={2020},
      eprint={2003.12039},
      archivePrefix={arXiv},
      primaryClass={cs.CV},
      url={https://arxiv.org/abs/2003.12039}, 
}

Copied from the authors' citation block at arxiv.org/abs/2003.12039.

Verified against LibreYOLO v1.8.0. Support tables, checkpoints and benchmark numbers on this page are generated from the released library and the published weights, not written by hand.