mmflow

OpenMMLab optical flow toolbox and benchmark

https://github.com/open-mmlab/mmflow

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary

Keywords

openmmlab optical-flow pytorch
Last synced: 6 months ago · JSON representation ·

Repository

OpenMMLab optical flow toolbox and benchmark

Basic Info
Statistics
  • Stars: 1,032
  • Watchers: 6
  • Forks: 117
  • Open Issues: 39
  • Releases: 10
Topics
openmmlab optical-flow pytorch
Created over 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Code of conduct Citation

README.md

 
OpenMMLab website HOT      OpenMMLab platform TRY IT OUT
 
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mmflow)](https://pypi.org/project/mmflow/) [![PyPI](https://img.shields.io/pypi/v/mmflow)](https://pypi.org/project/mmflow) [![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmflow.readthedocs.io/en/latest/) [![badge](https://github.com/open-mmlab/mmflow/workflows/build/badge.svg)](https://github.com/open-mmlab/mmflow/actions) [![codecov](https://codecov.io/gh/open-mmlab/mmflow/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmflow) [![license](https://img.shields.io/github/license/open-mmlab/mmflow.svg)](https://github.com/open-mmlab/mmflow/blob/master/LICENSE) [![open issues](https://isitmaintained.com/badge/open/open-mmlab/mmflow.svg)](https://github.com/open-mmlab/mmflow/issues) [📘Documentation](https://mmflow.readthedocs.io/en/latest/) | [🛠️Installation](https://mmflow.readthedocs.io/en/latest/install.html) | [👀Model Zoo](https://mmflow.readthedocs.io/en/latest/model_zoo.html) | [🤔Reporting Issues](https://github.com/open-mmlab/mmflow/issues/new/choose)
English | [简体中文](README_zh-CN.md)

Introduction

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+.

https://user-images.githubusercontent.com/76149310/141947796-af4f1e67-60c9-48ed-9dd6-fcd809a7d991.mp4

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

v0.5.2 was released in 01/10/2023:

  • Add flow1d attention

Please refer to changelog.md for details and release history.

Installation

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

Get 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:

Benchmark and model zoo

Results and models are available in the model zoo.

Supported methods:

Contributing

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

Acknowledgement

MMFlow is an open source project that is contributed by researchers and engineers from various colleges and companies. We appreciate all the contributors who implement their methods or add new features, as well as users who give valuable feedbacks. We wish that the toolbox and benchmark could serve the growing research community by providing a flexible toolkit to reimplement existing methods and develop their own new flow algorithm.

Citation

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

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

License

This project is released under the Apache 2.0 license.

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.
  • 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.

Owner

  • Name: OpenMMLab
  • Login: open-mmlab
  • Kind: organization
  • Location: China

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - name: "MMFlow Contributors"
title: "MMFlow: OpenMMLab Optical Flow Toolbox and Benchmark"
date-released: 2021-11-16
url: "https://github.com/open-mmlab/mmflow"
license: Apache-2.0

GitHub Events

Total
  • Watch event: 68
  • Issue comment event: 2
  • Fork event: 5
Last Year
  • Watch event: 68
  • Issue comment event: 2
  • Fork event: 5

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 134
  • Total Committers: 13
  • Avg Commits per committer: 10.308
  • Development Distribution Score (DDS): 0.187
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Miao Zheng 7****g 109
Zachary-66 5****6 9
Zaida Zhou 5****a 5
Hao Luo 1****1 2
碼農 s****8@g****m 1
salvatorestarace 5****h 1
lyq10085 5****5 1
Zekun Li 4****t 1
Tong Gao g****o@g****m 1
Sheffield 4****o 1
HiiiXinyiii 6****v 1
Fc-idris 7****s 1
gxiaotian g****n@o****m 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 36
  • Total pull requests: 85
  • Average time to close issues: 29 days
  • Average time to close pull requests: 3 days
  • Total issue authors: 26
  • Total pull request authors: 14
  • Average comments per issue: 1.81
  • Average comments per pull request: 0.62
  • Merged pull requests: 70
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 1.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • pedroHuang123 (7)
  • Salvatore-tech (4)
  • hoseinCode (2)
  • pknmax (1)
  • luis2r (1)
  • JamesYang-7 (1)
  • wojiaohumaocheng (1)
  • Jockey721 (1)
  • JLMarta (1)
  • zhujilin1995 (1)
  • DelinQu (1)
  • pekopoke (1)
  • leiwen83 (1)
  • nihalgupta84 (1)
  • Bilybill (1)
Pull Request Authors
  • Zachary-66 (38)
  • MeowZheng (29)
  • pedroHuang123 (4)
  • Fc-idris (3)
  • Salvatore-tech (2)
  • tctco (2)
  • crazysteeaam (1)
  • ice-tong (1)
  • lhao0301 (1)
  • Weepingchestnut (1)
  • HiiiXinyiii (1)
  • xiexinch (1)
  • gxiaotian (1)
  • forkbabu (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 139 last-month
  • Total docker downloads: 191
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 19
  • Total maintainers: 1
proxy.golang.org: github.com/open-mmlab/mmflow
  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 6.5%
Average: 6.7%
Dependent repos count: 6.9%
Last synced: 6 months ago
pypi.org: mmflow

OpenMMLab Optical flow Toolbox and Benchmark

  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 139 Last month
  • Docker Downloads: 191
Rankings
Stargazers count: 2.3%
Forks count: 4.6%
Dependent packages count: 7.5%
Downloads: 13.4%
Average: 19.5%
Dependent repos count: 69.8%
Maintainers (1)
Last synced: 6 months ago

Dependencies

requirements/build.txt pypi
  • numpy *
requirements/docs.txt pypi
  • docutils ==0.16.0
  • myst-parser *
  • sphinx ==4.0.2
  • sphinx-copybutton *
  • sphinx_markdown_tables *
  • sphinx_rtd_theme ==0.5.2
requirements/mminstall.txt pypi
  • mmcv-full >=1.3.15,<1.7.0
requirements/optional.txt pypi
  • scipy *
  • sklearn *
requirements/readthedocs.txt pypi
  • mmcv *
  • torch *
  • torchvision *
requirements/runtime.txt pypi
  • matplotlib *
  • numpy *
  • six *
requirements/tests.txt pypi
  • asynctest * test
  • codecov * test
  • coverage * test
  • flake8 * test
  • interrogate * test
  • kwarray * test
  • matplotlib * test
  • pytest * test
  • ubelt * test
  • xdoctest >=0.10.0 test
  • yapf * test
.github/workflows/build.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v2 composite
.github/workflows/lint.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/publish-to-pypi.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
.github/workflows/test_mim.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
docker/Dockerfile docker
  • pytorch/pytorch ${PYTORCH}-cuda${CUDA}-cudnn${CUDNN}-devel build
docker/serve/Dockerfile docker
  • pytorch/pytorch ${PYTORCH}-cuda${CUDA}-cudnn${CUDNN}-devel build
requirements.txt pypi
setup.py pypi