Merge pull request #18 from hmorimitsu/models

Models

Author: hmorimitsu

.github/workflows/pytest.yml

@@ -18,7 +18,7 @@ jobs:
       matrix:
         python-version: [3.6, 3.9]
         torch: [1.7.1, 1.9.0]
-        pytorch-lightning: [1.1.8, 1.3.7]
+        pytorch-lightning: [1.1.8, 1.4.0]
 
     steps:
       - uses: actions/checkout@v2

README.md

@@ -23,10 +23,12 @@ This is still under development, so some things may not work as intended. I plan
 
 ## Available models
 
+- DICL-Flow [https://arxiv.org/abs/2010.14851](https://arxiv.org/abs/2010.14851)
 - FlowNet - [https://arxiv.org/abs/1504.06852](https://arxiv.org/abs/1504.06852)
 - FlowNet2 - [https://arxiv.org/abs/1612.01925](https://arxiv.org/abs/1612.01925)
 - HD3 - [https://arxiv.org/abs/1812.06264](https://arxiv.org/abs/1812.06264)
 - IRR - [https://arxiv.org/abs/1904.05290](https://arxiv.org/abs/1904.05290)
+- LCV - [https://arxiv.org/abs/2007.11431](https://arxiv.org/abs/2007.11431)
 - LiteFlowNet [https://arxiv.org/abs/1805.07036](https://arxiv.org/abs/1805.07036)
 - LiteFlowNet2 [https://arxiv.org/abs/1903.07414](https://arxiv.org/abs/1903.07414)
 - LiteFlowNet3 [https://arxiv.org/abs/2007.09319](https://arxiv.org/abs/2007.09319)

docs/source/_static/kitti_2012_epe_outlier-drop_kitti_sintel.html

@@ -1,4 +1,8 @@
 PTLFlow name,Original name,Source
+dicl-chairs-fdc24e2f.ckpt,ckpt_chairs.pth.tar,https://github.com/jytime/DICL-Flow
+dicl-kitti-4813ccab.ckpt,ckpt_kitti.pth.tar,
+dicl-sintel-fa9fc259.ckpt,ckpt_sintel.pth.tar,
+dicl-things-20bc573d.ckpt,ckpt_things.pth.tar,
 flownet2-things-d63b53a7.ckpt,FlowNet2_checkpoint.pth.tar,https://github.com/NVIDIA/flownet2-pytorch
 flownetc-things-cc8ac7fd.ckpt,FlowNet2-C_checkpoint,
 flownetcs-things-4bdecffa.ckpt,FlowNet2-CS_checkpoint,
@@ -19,6 +23,8 @@ irr_pwc-sintel-6ad65777.ckpt,IRR-PWC_sintel-best,
 irr_pwc-things-c143e848.ckpt,IRR-PWC_things3d-best,
 irr_pwcnet-things-3f7fb8ca.ckpt,PWCNet-best,
 irr_pwcnet_irr-things-41a07190.ckpt,PWCNet-irr-best,
+lcv_raft-chairs-8063d698.ckpt,Original,PTLFlow
+lcv_raft-things-4c7233b8.ckpt,Original,
 liteflownet-kitti-49f1991a.ckpt,liteflownet-ft-kitti.caffemodel,https://github.com/twhui/LiteFlowNet
 liteflownet-sintel-17991e50.ckpt,liteflownet-ft-sintel.caffemodel,
 liteflownet-things-a4d066e2.ckpt,liteflownet.caffemodel,

docs/source/_static/kitti_2015_epe_outlier-drop_kitti_sintel.html

@@ -7,6 +7,17 @@ Below is a list and a brief explanation about the models currently available on
 List of models
 ==============
 
+DICL-Flow
+---------
+
+`[source code] <https://github.com/hmorimitsu/ptlflow/tree/main/ptlflow/models/dicl>`__
+
+- Paper: **Displacement-Invariant Matching Cost Learning for Accurate Optical Flow Estimation** - `https://arxiv.org/abs/2010.14851 <https://arxiv.org/abs/2010.14851>`_
+
+- Reference code: `https://github.com/jytime/DICL-Flow <https://github.com/jytime/DICL-Flow>`_
+
+- Model names: ``dicl``
+
 Flownet
 -------
 
@@ -45,6 +56,18 @@ IRR
 
 - Model names: ``irr_pwc``, ``irr_pwcnet``, ``irr_pwcnet_irr``
 
+
+LCV
+---
+
+`[source code] <https://github.com/hmorimitsu/ptlflow/tree/main/ptlflow/models/lcv>`__
+
+- Paper: **Learnable Cost Volume Using the Cayley Representation** - `https://arxiv.org/abs/2007.11431 <https://arxiv.org/abs/2007.11431>`_
+
+- Reference code: `https://github.com/Prinsphield/LCV <https://github.com/Prinsphield/LCV>`_
+
+- Model names: ``lcv_raft``, ``lcv_raft_small``
+
 LiteFlowNet
 -----------
 

docs/source/_static/sintel_clean_epe_outlier-drop_kitti_sintel.html

@@ -1,4 +1,8 @@
 model,checkpoint,sintel-final-trainval-occ-val/epe,sintel-final-trainval-occ-val/px1,sintel-final-trainval-occ-val/px3,sintel-final-trainval-occ-val/px5,sintel-final-trainval-occ-val/outlier,sintel-final-trainval-occ-val/epe_occ,sintel-final-trainval-occ-val/epe_non_occ,sintel-final-trainval-occ-val/px1_occ,sintel-final-trainval-occ-val/px1_non_occ,sintel-final-trainval-occ-val/px3_occ,sintel-final-trainval-occ-val/px3_non_occ,sintel-final-trainval-occ-val/px5_occ,sintel-final-trainval-occ-val/px5_non_occ,sintel-final-trainval-occ-val/outlier_occ,sintel-final-trainval-occ-val/outlier_non_occ,sintel-final-trainval-occ-val/occ_f1,sintel-final-trainval-occ-val/conf_f1,sintel-clean-trainval-occ-val/epe,sintel-clean-trainval-occ-val/px1,sintel-clean-trainval-occ-val/px3,sintel-clean-trainval-occ-val/px5,sintel-clean-trainval-occ-val/outlier,sintel-clean-trainval-occ-val/epe_occ,sintel-clean-trainval-occ-val/epe_non_occ,sintel-clean-trainval-occ-val/px1_occ,sintel-clean-trainval-occ-val/px1_non_occ,sintel-clean-trainval-occ-val/px3_occ,sintel-clean-trainval-occ-val/px3_non_occ,sintel-clean-trainval-occ-val/px5_occ,sintel-clean-trainval-occ-val/px5_non_occ,sintel-clean-trainval-occ-val/outlier_occ,sintel-clean-trainval-occ-val/outlier_non_occ,sintel-clean-trainval-occ-val/occ_f1,sintel-clean-trainval-occ-val/conf_f1,kitti-2012-trainval-val/epe,kitti-2012-trainval-val/px1,kitti-2012-trainval-val/px3,kitti-2012-trainval-val/px5,kitti-2012-trainval-val/outlier,kitti-2012-trainval-val/conf_f1,kitti-2015-trainval-val/epe,kitti-2015-trainval-val/px1,kitti-2015-trainval-val/px3,kitti-2015-trainval-val/px5,kitti-2015-trainval-val/outlier,kitti-2015-trainval-val/conf_f1
+dicl,chairs,4.947,0.751,0.865,0.891,0.132,11.704,3.699,0.372,0.78,0.616,0.891,0.697,0.915,0.373,0.107,,,3.661,0.82,0.909,0.927,0.089,10.274,2.389,0.427,0.853,0.67,0.936,0.742,0.951,0.319,0.063,,,5.968,0.44,0.712,0.793,0.281,,18.445,0.376,0.541,0.602,0.456,
+dicl,kitti,9.598,0.634,0.765,0.804,0.234,16.165,8.47,0.299,0.653,0.51,0.785,0.6,0.822,0.482,0.214,,,7.798,0.69,0.804,0.838,0.195,14.635,6.558,0.318,0.714,0.54,0.827,0.63,0.859,0.451,0.172,,,1.161,0.829,0.938,0.961,0.046,,1.393,0.779,0.913,0.946,0.058,
+dicl,sintel,2.05,0.856,0.922,0.941,0.075,6.031,1.397,0.496,0.886,0.719,0.945,0.793,0.96,0.268,0.053,,,1.297,0.902,0.951,0.964,0.046,4.894,0.678,0.546,0.936,0.76,0.975,0.828,0.982,0.226,0.024,,,2.161,0.759,0.904,0.938,0.081,,5.656,0.663,0.816,0.859,0.164,
+dicl,things,3.831,0.811,0.889,0.913,0.107,9.903,2.709,0.418,0.843,0.648,0.915,0.727,0.935,0.341,0.082,,,2.006,0.878,0.939,0.954,0.059,6.691,1.121,0.488,0.914,0.73,0.964,0.801,0.974,0.258,0.034,,,3.745,0.695,0.849,0.889,0.14,,9.906,0.599,0.75,0.791,0.24,
 flownet2,things,3.97,0.772,0.872,0.901,0.124,9.338,2.978,0.413,0.799,0.633,0.896,0.717,0.922,0.355,0.101,,,3.005,0.821,0.907,0.929,0.09,7.867,2.101,0.455,0.851,0.685,0.931,0.764,0.95,0.304,0.066,,,5.468,0.599,0.775,0.823,0.219,,13.143,0.499,0.65,0.699,0.346,
 flownetc,things,5.647,0.466,0.76,0.832,0.238,11.412,4.579,0.189,0.481,0.491,0.782,0.614,0.854,0.501,0.216,,,4.545,0.479,0.797,0.865,0.2,9.915,3.557,0.195,0.494,0.526,0.822,0.658,0.889,0.466,0.175,,,8.104,0.198,0.57,0.689,0.426,,15.985,0.179,0.462,0.569,0.536,
 flownetcs,things,4.164,0.735,0.857,0.892,0.14,9.498,3.21,0.337,0.763,0.6,0.882,0.699,0.915,0.389,0.115,,,3.131,0.787,0.893,0.921,0.103,8.089,2.226,0.375,0.818,0.652,0.919,0.747,0.943,0.336,0.078,,,5.028,0.558,0.774,0.831,0.218,,12.517,0.452,0.639,0.699,0.356,
@@ -19,6 +23,8 @@ irr_pwc,sintel,2.443,0.849,0.916,0.937,0.08,6.666,1.715,0.502,0.878,0.718,0.937,
 irr_pwc,things,3.404,0.81,0.893,0.918,0.104,8.566,2.46,0.435,0.839,0.661,0.917,0.74,0.939,0.327,0.08,0.725,,1.856,0.87,0.936,0.952,0.062,6.302,1.035,0.492,0.904,0.722,0.96,0.796,0.972,0.265,0.038,0.752,,3.55,0.664,0.842,0.886,0.146,,9.508,0.556,0.726,0.777,0.264,
 irr_pwcnet,things,4.411,0.77,0.868,0.897,0.129,10.869,3.211,0.358,0.802,0.597,0.896,0.687,0.922,0.392,0.102,,,3.09,0.82,0.907,0.929,0.091,9.114,1.964,0.395,0.856,0.646,0.936,0.734,0.953,0.342,0.063,,,5.967,0.538,0.774,0.834,0.219,,14.707,0.452,0.635,0.695,0.361,
 irr_pwcnet_irr,things,4.052,0.755,0.867,0.9,0.129,10.112,2.968,0.357,0.784,0.599,0.894,0.691,0.924,0.39,0.103,,,2.734,0.809,0.908,0.932,0.089,8.447,1.692,0.394,0.842,0.647,0.936,0.738,0.956,0.34,0.061,,,5.145,0.509,0.76,0.83,0.232,,12.983,0.441,0.636,0.7,0.358,
+lcv_raft,chairs,4.034,0.753,0.882,0.911,0.115,9.937,2.93,0.409,0.779,0.655,0.907,0.732,0.933,0.334,0.09,,,2.282,0.81,0.924,0.947,0.073,7.009,1.388,0.469,0.839,0.714,0.949,0.79,0.968,0.272,0.048,,,4.371,0.36,0.713,0.824,0.277,,9.213,0.359,0.625,0.723,0.367,
+lcv_raft,things,2.981,0.828,0.909,0.931,0.087,7.792,2.099,0.48,0.858,0.702,0.932,0.775,0.951,0.285,0.065,,,1.761,0.874,0.945,0.961,0.052,5.824,0.975,0.531,0.907,0.757,0.969,0.826,0.98,0.229,0.03,,,2.509,0.678,0.874,0.917,0.114,,6.13,0.595,0.789,0.837,0.197,
 liteflownet,kitti,5.917,0.738,0.842,0.872,0.156,13.327,4.57,0.331,0.767,0.551,0.869,0.639,0.897,0.439,0.129,,,4.553,0.796,0.88,0.903,0.118,11.64,3.234,0.356,0.833,0.59,0.911,0.677,0.93,0.399,0.088,,,1.164,0.829,0.942,0.965,0.041,,1.783,0.779,0.907,0.938,0.065,
 liteflownet,sintel,1.845,0.856,0.923,0.943,0.073,5.549,1.229,0.492,0.889,0.724,0.947,0.799,0.963,0.261,0.049,,,1.419,0.905,0.948,0.961,0.049,5.239,0.756,0.535,0.944,0.754,0.974,0.821,0.98,0.231,0.025,,,3.661,0.736,0.866,0.9,0.125,,10.354,0.631,0.758,0.794,0.235,
 liteflownet,things,4.024,0.786,0.879,0.906,0.118,10.306,2.84,0.37,0.819,0.619,0.907,0.705,0.93,0.37,0.09,,,2.504,0.851,0.924,0.942,0.074,7.918,1.45,0.417,0.891,0.682,0.954,0.764,0.967,0.306,0.045,,,4.532,0.627,0.802,0.849,0.191,,11.477,0.522,0.683,0.734,0.311,