Metadata-Version: 2.1
Name: ezflow
Version: 0.2.0
Summary: A PyTorch library for optical flow estimation using neural networks
Home-page: https://github.com/neu-vig/ezflow
Author: Neelay Shah
Author-email: nstraum1@gmail.com
License: MIT
Project-URL: Source, https://github.com/neu-vig/ezflow
Description: <p align="center">
            <br>
            <img src="./docs/assets/logo.png" height="60" width="60"/>
            <br>
        </p>
        
        <h1 align="center">EzFlow</h1>
        <h3 align="center">A modular PyTorch library for optical flow estimation using neural networks</h3>
        
        <div align='center'>
        
        [![Tests](https://github.com/neu-vig/ezflow/actions/workflows/package-test.yml/badge.svg)](https://github.com/neu-vig/ezflow/actions/workflows/package-test.yml)
        [![Docs](https://readthedocs.org/projects/ezflow/badge/?version=latest)](https://ezflow.readthedocs.io/en/latest/?badge=latest)
        
        <!-- [![Code style](https://github.com/neu-vig/ezflow/actions/workflows/linting.yml/badge.svg)](https://github.com/neu-vig/ezflow/actions/workflows/linting.yml) -->
        <!-- [![Code coverage](https://github.com/neu-vig/ezflow/actions/workflows/codecov.yml/badge.svg)](https://github.com/neu-vig/ezflow/actions/workflows/codecov.yml) -->
        
        **[Documentation](https://ezflow.readthedocs.io/en/latest/)** | **[Tutorials](https://ezflow.readthedocs.io/en/latest/tutorials/index.html)**
        
        </div>
        
        
        ## Installation
        
        ### From source (recommended)
        
        ```shell
        
        git clone https://github.com/neu-vig/ezflow
        cd ezflow/
        python setup.py install
        
        ```
        
        ### From PyPI
        
        ```shell
        
        pip install ezflow
        
        ```
        
        ### Models supported
        
        - [x] [DICL](https://arxiv.org/abs/2010.14851)
        - [x] [FlowNetS](https://arxiv.org/abs/1504.06852)
        - [x] [FlowNetC](https://arxiv.org/abs/1504.06852)
        - [x] [PWCNet](https://arxiv.org/abs/1709.02371)
        - [x] [RAFT](https://arxiv.org/abs/2003.12039)
        - [x] [VCN](https://papers.nips.cc/paper/2019/hash/bbf94b34eb32268ada57a3be5062fe7d-Abstract.html)
        
        ### Datasets supported
        
        - [x] [AutoFlow](https://autoflow-google.github.io/)
        - [x] [FlyingChairs](https://lmb.informatik.uni-freiburg.de/resources/datasets/FlyingChairs.en.html#flyingchairs)
        - [x] [HD1K](http://hci-benchmark.iwr.uni-heidelberg.de/)
        - [x] [KITTI](http://www.cvlibs.net/datasets/kitti/eval_scene_flow.php?benchmark=flow)
        - [x] [MPI Sintel](http://sintel.is.tue.mpg.de/)
        - [x] [SceneFlow Monkaa](https://lmb.informatik.uni-freiburg.de/resources/datasets/SceneFlowDatasets.en.html)
        - [x] [SceneFlow Driving](https://lmb.informatik.uni-freiburg.de/resources/datasets/SceneFlowDatasets.en.html)
        - [x] [SceneFlow FlyingThings3D](https://lmb.informatik.uni-freiburg.de/resources/datasets/SceneFlowDatasets.en.html)
        - [x] [SceneFlow FlyingThings3D subset](https://lmb.informatik.uni-freiburg.de/resources/datasets/SceneFlowDatasets.en.html)
        
        ### References
        
        - [RAFT](https://github.com/princeton-vl/RAFT)
        - [DICL-Flow](https://github.com/jytime/DICL-Flow)
        - [PWC-Net](https://github.com/NVlabs/PWC-Net)
        - [FlowNetPytorch](https://github.com/ClementPinard/FlowNetPytorch)
        - [VCN](https://github.com/gengshan-y/VCN)
        - [detectron2](https://github.com/facebookresearch/detectron2)
        - [CorrelationLayer](https://github.com/oblime/CorrelationLayer)
        - [ptflow](https://github.com/hmorimitsu/ptlflow)
        
        
        <br>
        
        <footer>
        <a target="_blank" href="https://icons8.com/icon/3Nj3FNnz36Id/pixels">Pixels</a> icon by <a target="_blank" href="https://icons8.com">Icons8</a>
        </footer>
        
        
        
        
Keywords: optical flow,pytorch,machine learning,deep learning
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
