zhouzaida / mmflow

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PyPI - Python Version PyPI docs badge codecov license open issues

Documentation: https://mmflow.readthedocs.io/


English | 简体中文

MMFlow is an open source optical flow toolbox based on PyTorch. It is a part of the OpenMMLab project.

The master branch works with PyTorch 1.5+.


Major features

  • The First Unified Framework for Optical Flow

    MMFlow is the first toolbox that provides a framework for unified implementation and evaluation of optical flow algorithms.

  • Flexible and Modular Design

    We decompose the flow estimation framework into different components, which makes it much easy and flexible to build a new model by combining different modules.

  • Plenty of Algorithms and Datasets Out of the Box

    The toolbox directly supports popular and contemporary optical flow models, e.g. FlowNet, PWC-Net, RAFT, etc, and representative datasets, FlyingChairs, FlyingThings3D, Sintel, KITTI, etc.


This project is released under the Apache 2.0 license.

Benchmark and model zoo

Results and models are available in the model zoo.

Supported methods:


Please refer to install.md for installation and guidance in dataset_prepare for dataset preparation.

Getting Started

If you're new of optical flow, you can start with learn the basics. If you’re familiar with it, check out getting_started to try out MMFlow.

Refer to the below tutorials to dive deeper:


We appreciate all contributions improving MMFlow. Please refer to CONTRIBUTING.md in MMCV for more details about the contributing guideline.


If you use this toolbox or benchmark in your research, please cite this project.

    title={{MMFlow}: OpenMMLab Optical Flow Toolbox and Benchmark},
    author={MMFlow Contributors},
    howpublished = {\url{https://github.com/open-mmlab/mmflow}},

Projects in OpenMMLab

  • MMCV: OpenMMLab foundational library for computer vision.
  • MIM: MIM Installs OpenMMLab Packages.
  • MMClassification: OpenMMLab image classification toolbox and benchmark.
  • MMDetection: OpenMMLab detection toolbox and benchmark.
  • MMDetection3D: OpenMMLab's next-generation platform for general 3D object detection.
  • MMSegmentation: OpenMMLab semantic segmentation toolbox and benchmark.
  • MMAction2: OpenMMLab's next-generation action understanding toolbox and benchmark.
  • MMTracking: OpenMMLab video perception toolbox and benchmark.
  • MMPose: OpenMMLab pose estimation toolbox and benchmark.
  • MMEditing: OpenMMLab image and video editing toolbox.
  • MMOCR: A Comprehensive Toolbox for Text Detection, Recognition and Understanding.
  • MMGeneration: OpenMMLab image and video generative models toolbox.
  • MMFlow: OpenMMLab optical flow toolbox and benchmark.
  • MMFewShot: OpenMMLab FewShot Learning Toolbox and Benchmark.
  • MMHuman3D: OpenMMLab Human Pose and Shape Estimation Toolbox and Benchmark.


License:Apache License 2.0


Language:Python 99.6%Language:Dockerfile 0.2%Language:Shell 0.2%