OpenMMLab Optical flow Toolbox and Benchmark
Project description
Documentation: https://mmflow.readthedocs.io/en/1.x
Introduction
English | 简体中文
MMFlow is an open source optical flow toolbox based on PyTorch. It is a part of the OpenMMLab project.
The 1.x branch works with PyTorch 1.6+.
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.
What's New
v1.0.0rc0 was released in 31/8/2022. Please refer to changelog.md for details and release history.
- Unifies interfaces of all components based on MMEngine.
- Faster training and testing speed with complete support of mixed precision training.
- Refactored and more flexible architecture.
Installation
Please refer to install.md for installation and guidance in dataset_prepare for dataset preparation.
Get Started
Please see Overview for the general introduction of MMFlow.
Please see user guides for the basic usage of MMFlow. There are also advanced tutorials for in-depth understanding of mmflow design and implementation .
To migrate from MMFlow 0.x, please refer to migration.
Benchmark and model zoo
Results and models are available in the model zoo.
Supported methods:
- FlowNet (ICCV'2015)
- FlowNet2 (CVPR'2017)
- PWC-Net (CVPR'2018)
- LiteFlowNet (CVPR'2018)
- LiteFlowNet2 (TPAMI'2020)
- IRR (CVPR'2019)
- MaskFlownet (CVPR'2020)
- RAFT (ECCV'2020)
- GMA (ICCV' 2021)
Contributing
We appreciate all contributions improving MMFlow. Please refer to CONTRIBUTING.md for more details about the contributing guideline.
Citation
If you use this toolbox or benchmark in your research, please cite this project.
@misc{2021mmflow,
title={{MMFlow}: OpenMMLab Optical Flow Toolbox and Benchmark},
author={MMFlow Contributors},
howpublished = {\url{https://github.com/open-mmlab/mmflow}},
year={2021}
}
Projects in OpenMMLab
- MMEngine: OpenMMLab foundational library for training deep learning models
- 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.
- MMRotate: OpenMMLab rotated object detection toolbox and benchmark.
- MMSegmentation: OpenMMLab semantic segmentation toolbox and benchmark.
- MMOCR: OpenMMLab text detection, recognition, and understanding toolbox.
- MMPose: OpenMMLab pose estimation toolbox and benchmark.
- MMHuman3D: OpenMMLab 3D human parametric model toolbox and benchmark.
- MMSelfSup: OpenMMLab self-supervised learning toolbox and benchmark.
- MMRazor: OpenMMLab model compression toolbox and benchmark.
- MMFewShot: OpenMMLab fewshot learning toolbox and benchmark.
- MMAction2: OpenMMLab's next-generation action understanding toolbox and benchmark.
- MMTracking: OpenMMLab video perception toolbox and benchmark.
- MMFlow: OpenMMLab optical flow toolbox and benchmark.
- MMEditing: OpenMMLab image and video editing toolbox.
- MMGeneration: OpenMMLab image and video generative models toolbox.
- MMDeploy: OpenMMLab Model Deployment Framework.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mmflow-1.0.0rc0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53f5498d170b86ad21517149444b850fbf9a4961e8018fb1c468af65bd3de1c3 |
|
MD5 | 6d1997cb1bd7887e67729a5524f78b27 |
|
BLAKE2b-256 | c0214f64f31246c34ddf579da70f3f141b6af3248b23dce9ba765ec7788b1fda |