Skip to main content

PyTorch Lightning Optical Flow

Project description

PyTorch Lightning Optical Flow

GitHub CI python status GitHub CI pytorch status GitHub CI lightning status GitHub CI build status

Introduction

This is a collection of state-of-the-art deep model for estimating optical flow. The main goal is to provide a unified framework where multiple models can be trained and tested more easily.

The work and code from many others are present here. I tried to make sure everything is properly referenced, but please let me know if I missed something.

This is still under development, so some things may not work as intended. I plan to add more models in the future, as well keep improving the platform.

What's new

- v0.3.2

- v0.3.1

- v0.3.0

Available models

Read more details about the models on https://ptlflow.readthedocs.io/en/latest/models/models_list.html.

Results

You can see a table with main evaluation results of the available models here. More results are also available in the folder docs/source/results.

Disclaimer: These results are the ones obtained by evaluating the available models in this framework in my machine. Your results may be different due to differences in hardware and software. I also do not guarantee that the results of each model will be similar to the ones presented in the respective papers or other original sources. If you need to replicate the original results from a paper, you should use the original implementations.

Getting started

Please take a look at the documentation to learn how to install and use PTLFlow.

You can also check the notebooks below running on Google Colab for some practical examples:

Licenses

The original code of this repository is licensed under the Apache 2.0 license.

Each model may be subjected to different licenses. The license of each model is included in their respective folders. It is your responsibility to make sure that your project is in compliance with all the licenses and conditions involved.

The external pretrained weights all have different licenses, which are listed in their respective folders.

The pretrained weights that were trained within this project are available under the CC BY-NC-SA 4.0 license, which I believe that covers the licenses of the datasets used in the training. That being said, I am not a legal expert so if you plan to use them to any purpose other than research, you should check all the involved licenses by yourself. Additionally, the datasets used for the training usually require the user to cite the original papers, so be sure to include their respective references in your work.

Contributing

Contribution are welcome! Please check CONTRIBUTING.md to see how to contribute.

Citing

BibTeX

@misc{morimitsu2021ptlflow,
  author = {Henrique Morimitsu},
  title = {PyTorch Lightning Optical Flow},
  year = {2021},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/hmorimitsu/ptlflow}}
}

Acknowledgements

  • This README file is heavily inspired by the one from the timm repository.
  • Some parts of the code were inspired by or taken from FlowNetPytorch.
  • flownet2-pytorch was also another important source.
  • The current main training routine is based on RAFT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ptlflow-0.3.2.tar.gz (697.3 kB view details)

Uploaded Source

Built Distribution

ptlflow-0.3.2-py3-none-any.whl (862.7 kB view details)

Uploaded Python 3

File details

Details for the file ptlflow-0.3.2.tar.gz.

File metadata

  • Download URL: ptlflow-0.3.2.tar.gz
  • Upload date:
  • Size: 697.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for ptlflow-0.3.2.tar.gz
Algorithm Hash digest
SHA256 c49701a31653953846b8d5701ad323ff771283a1b44e2841b705c76c4b1be427
MD5 66fdaed6236d10928f209fa764f85e3a
BLAKE2b-256 a6f621959fda33a9874c3d6ae72720e7d6df8bec1e7449f2e4b6ed5a1b0ea02f

See more details on using hashes here.

File details

Details for the file ptlflow-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: ptlflow-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 862.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for ptlflow-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f28f2bdfe32951a1206fc9dd569ea01c862372601c207338c56e851ea8fd1da9
MD5 2abf57ddd68055f74e31b10e551e3656
BLAKE2b-256 19da03dee68bf46603f77d3b3d3426dfecabb53b53ecbedfb0265afee1557097

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page