update: Supported Algorithms

README.md

@@ -44,8 +44,9 @@ The tool currently supports various popular image matching algorithms, namely:
 - [ ] [ASTR](https://github.com/ASTR2023/ASTR), CVPR 2023
 - [ ] [SEM](https://github.com/SEM2023/SEM), CVPR 2023
 - [ ] [DeepLSD](https://github.com/cvg/DeepLSD), CVPR 2023
-- [x] [GlueStick](https://github.com/cvg/GlueStick), ArXiv 2023
+- [x] [GlueStick](https://github.com/cvg/GlueStick), ICCV 2023
 - [ ] [ConvMatch](https://github.com/SuhZhang/ConvMatch), AAAI 2023
+- [x] [LoFTR](https://github.com/zju3dv/LoFTR), CVPR 2021
 - [x] [SOLD2](https://github.com/cvg/SOLD2), CVPR 2021
 - [ ] [LineTR](https://github.com/yosungho/LineTR), RA-L 2021
 - [x] [DKM](https://github.com/Parskatt/DKM), CVPR 2023
@@ -55,7 +56,7 @@ The tool currently supports various popular image matching algorithms, namely:
 - [x] [LANet](https://github.com/wangch-g/lanet), ACCV 2022
 - [ ] [LISRD](https://github.com/rpautrat/LISRD), ECCV 2022
 - [ ] [REKD](https://github.com/bluedream1121/REKD), CVPR 2022
-- [x] [ALIKE](https://github.com/Shiaoming/ALIKE), ArXiv 2022
+- [x] [ALIKE](https://github.com/Shiaoming/ALIKE), TMM 2022
 - [x] [RoRD](https://github.com/UditSinghParihar/RoRD), IROS 2021
 - [x] [SGMNet](https://github.com/vdvchen/SGMNet), ICCV 2021
 - [x] [SuperPoint](https://github.com/magicleap/SuperPointPretrainedNetwork), CVPRW 2018
@@ -65,10 +66,10 @@ The tool currently supports various popular image matching algorithms, namely:
 - [x] [DISK](https://github.com/cvlab-epfl/disk), NeurIPS 2020
 - [ ] [Key.Net](https://github.com/axelBarroso/Key.Net), ICCV 2019
 - [ ] [OANet](https://github.com/zjhthu/OANet), ICCV 2019
-- [ ] [SOSNet](https://github.com/scape-research/SOSNet), CVPR 2019
+- [x] [SOSNet](https://github.com/scape-research/SOSNet), CVPR 2019
+- [x] [HardNet](https://github.com/DagnyT/hardnet), NeurIPS 2017
 - [x] [SIFT](https://docs.opencv.org/4.x/da/df5/tutorial_py_sift_intro.html), IJCV 2004
 
-
 ## How to use
 
 ### HuggingFace / Lightning AI

common/app_class.py

@@ -200,13 +200,9 @@ class ImageMatchingApp:
                                 " Match)"
                             ),
                         )
-                    with gr.Accordion("Open for More!", open=False):
-                        gr.Markdown(
-                            f"""
-                            <h3>Supported Algorithms</h3>
-                            {", ".join(self.matcher_zoo.keys())}
-                            """
-                        )
+                    with gr.Accordion("Supported Algorithms", open=False):
+                        # add a table of supported algorithms
+                        self.display_supported_algorithms()
 
                 with gr.Column():
                     output_keypoints = gr.Image(label="Keypoints", type="numpy")
@@ -401,3 +397,58 @@ class ImageMatchingApp:
             self.cfg["defaults"]["ransac_max_iter"],  # ransac_max_iter: int
             self.cfg["defaults"]["setting_geometry"],  # geometry: str
         )
+
+    def display_supported_algorithms(self, style="tab"):
+        def get_link(link, tag="Link"):
+            return "[{}]({})".format(tag, link) if link is not None else "None"
+
+        data = []
+        cfg = self.cfg["matcher_zoo"]
+        if style == "md":
+            markdown_table = "| Algo. | Conference | Code | Project | Paper |\n"
+            markdown_table += (
+                "| ----- | ---------- | ---- | ------- | ----- |\n"
+            )
+
+            for k, v in cfg.items():
+                if not v["info"]["display"]:
+                    continue
+                github_link = get_link(v["info"]["github"])
+                project_link = get_link(v["info"]["project"])
+                paper_link = get_link(
+                    v["info"]["paper"],
+                    (
+                        Path(v["info"]["paper"]).name[-10:]
+                        if v["info"]["paper"] is not None
+                        else "Link"
+                    ),
+                )
+
+                markdown_table += "{}|{}|{}|{}|{}\n".format(
+                    v["info"]["name"], #display name
+                    v["info"]["source"],
+                    github_link,
+                    project_link,
+                    paper_link,
+                )
+            return gr.Markdown(markdown_table)
+        elif style == "tab":
+            for k, v in cfg.items():
+                if not v["info"]["display"]:
+                    continue
+                data.append(
+                    [
+                        v["info"]["name"],
+                        v["info"]["source"],
+                        v["info"]["github"],
+                        v["info"]["project"],
+                        v["info"]["paper"],
+                    ]
+                )
+            tab = gr.Dataframe(
+                headers=["Algo.", "Conference", "Code", "Project", "Paper"],
+                datatype=["str", "str", "str", "str", "str"],
+                col_count=(5, "fixed"),
+            )
+            tab.value = data
+            return tab

common/config.yaml

@@ -19,97 +19,279 @@ matcher_zoo:
   roma:
     matcher: roma
     dense: true
+    info: 
+      name: RoMa #dispaly name
+      source: "CVPR 2024"
+      github: https://github.com/Parskatt/RoMa
+      paper: https://arxiv.org/abs/2305.15404
+      project: https://parskatt.github.io/RoMa
+      display: true
   loftr:
     matcher: loftr
     dense: true
+    info: 
+      name: LoFTR #dispaly name
+      source: "CVPR 2021"
+      github: https://github.com/zju3dv/LoFTR
+      paper: https://arxiv.org/pdf/2104.00680
+      project: https://zju3dv.github.io/loftr
+      display: true
   topicfm:
     matcher: topicfm
     dense: true
+    info:
+      name: TopicFM #dispaly name
+      source: "AAAI 2023"
+      github: https://github.com/TruongKhang/TopicFM
+      paper: https://arxiv.org/abs/2307.00485
+      project: null
+      display: true
   aspanformer:
     matcher: aspanformer
     dense: true
+    info:
+      name: ASpanformer #dispaly name
+      source: "ECCV 2022"
+      github: https://github.com/Vincentqyw/ml-aspanformer
+      paper: https://arxiv.org/abs/2208.14201
+      project: null
+      display: true
   xfeat(sparse):
     matcher: NN-mutual
     feature: xfeat
     dense: false
+    info:
+      name: XFeat #dispaly name
+      source: "CVPR 2024"
+      github: https://github.com/verlab/accelerated_features
+      paper: https://arxiv.org/abs/2404.19174
+      project: null
+      display: true
   xfeat(dense):
     matcher: xfeat_dense
     dense: true
+    info:
+      name: XFeat #dispaly name
+      source: "CVPR 2024"
+      github: https://github.com/verlab/accelerated_features
+      paper: https://arxiv.org/abs/2404.19174
+      project: null
+      display: false
   dedode:
     matcher: Dual-Softmax
     feature: dedode
     dense: false
+    info:
+      name: DeDoDe #dispaly name
+      source: "3DV 2024"
+      github: https://github.com/Parskatt/DeDoDe
+      paper: https://arxiv.org/abs/2308.08479
+      project: null
+      display: true
   superpoint+superglue:
     matcher: superglue
     feature: superpoint_max
     dense: false
+    info:
+      name: SuperGlue #dispaly name
+      source: "CVPR 2020"
+      github: https://github.com/magicleap/SuperGluePretrainedNetwork
+      paper: https://arxiv.org/abs/1911.11763
+      project: null
+      display: true
   superpoint+lightglue:
     matcher: superpoint-lightglue
     feature: superpoint_max
     dense: false
+    info:
+      name: LightGlue #dispaly name
+      source: "ICCV 2023"
+      github: https://github.com/cvg/LightGlue
+      paper: https://arxiv.org/pdf/2306.13643
+      project: null
+      display: true
   disk:
     matcher: NN-mutual
     feature: disk
     dense: false
+    info:
+      name: DISK
+      source: "NeurIPS 2020"
+      github: https://github.com/cvlab-epfl/disk
+      paper: https://arxiv.org/abs/2006.13566
+      project: null
+      display: true
   disk+dualsoftmax:
     matcher: Dual-Softmax
     feature: disk
     dense: false
+    info:
+      name: DISK
+      source: "NeurIPS 2020"
+      github: https://github.com/cvlab-epfl/disk
+      paper: https://arxiv.org/abs/2006.13566
+      project: null
+      display: false
   superpoint+dualsoftmax:
     matcher: Dual-Softmax
     feature: superpoint_max
     dense: false
+    info:
+      name: SuperPoint
+      source: "CVPRW 2018"
+      github: https://github.com/magicleap/SuperPointPretrainedNetwork
+      paper: https://arxiv.org/abs/1712.07629
+      project: null
+      display: false
   disk+lightglue:
     matcher: disk-lightglue
     feature: disk
     dense: false
+    info:
+      name: LightGlue
+      source: "ICCV 2023"
+      github: https://github.com/cvg/LightGlue
+      paper: https://arxiv.org/pdf/2306.13643
+      project: null
+      display: true
   superpoint+mnn:
     matcher: NN-mutual
     feature: superpoint_max
     dense: false
+    info:
+      name: SuperPoint #dispaly name
+      source: "CVPRW 2018"
+      github: https://github.com/magicleap/SuperPointPretrainedNetwork
+      paper: https://arxiv.org/abs/1712.07629
+      project: null
+      display: true
   sift+sgmnet:
     matcher: sgmnet
     feature: sift
     dense: false
+    info:
+      name: SGMNet #dispaly name
+      source: "ICCV 2021"
+      github: https://github.com/vdvchen/SGMNet
+      paper: https://arxiv.org/abs/2108.08771
+      project: null
+      display: true
   sosnet:
     matcher: NN-mutual
     feature: sosnet
     dense: false
+    info:
+      name: SOSNet #dispaly name
+      source: "CVPR 2019"
+      github: https://github.com/scape-research/SOSNet
+      paper: https://arxiv.org/abs/1904.05019
+      project: https://research.scape.io/sosnet
+      display: true
   hardnet:
     matcher: NN-mutual
     feature: hardnet
     dense: false
+    info:
+      name: HardNet #dispaly name
+      source: "NeurIPS 2017"
+      github: https://github.com/DagnyT/hardnet
+      paper: https://arxiv.org/abs/1705.10872
+      project: null
+      display: true
   d2net:
     matcher: NN-mutual
     feature: d2net-ss
     dense: false
+    info:
+      name: D2Net #dispaly name
+      source: "CVPR 2019"
+      github: https://github.com/Vincentqyw/d2-net
+      paper: https://arxiv.org/abs/1905.03561
+      project: https://dusmanu.com/publications/d2-net.html
+      display: true
   rord:
     matcher: NN-mutual
     feature: rord
     dense: false
+    info:
+      name: RoRD #dispaly name
+      source: "IROS 2021"
+      github: https://github.com/UditSinghParihar/RoRD
+      paper: https://arxiv.org/abs/2103.08573
+      project: https://uditsinghparihar.github.io/RoRD/
+      display: true
   alike:
     matcher: NN-mutual
     feature: alike
     dense: false
+    info:
+      name: ALIKE #dispaly name
+      source: "TMM 2022"
+      github: https://github.com/Shiaoming/ALIKE
+      paper: https://arxiv.org/abs/2112.02906
+      project: null
+      display: true
   lanet:
     matcher: NN-mutual
     feature: lanet
     dense: false
+    info:
+      name: LANet #dispaly name
+      source: "ACCV 2022"
+      github: https://github.com/wangch-g/lanet
+      paper: https://openaccess.thecvf.com/content/ACCV2022/papers/Wang_Rethinking_Low-level_Features_for_Interest_Point_Detection_and_Description_ACCV_2022_paper.pdf
+      project: null
+      display: true
   r2d2:
     matcher: NN-mutual
     feature: r2d2
     dense: false
+    info:
+      name: R2D2 #dispaly name
+      source: "NeurIPS 2019"
+      github: https://github.com/naver/r2d2
+      paper: https://arxiv.org/abs/1906.06195
+      project: null
+      display: true
   darkfeat:
     matcher: NN-mutual
     feature: darkfeat
     dense: false
+    info:
+      name: DarkFeat #dispaly name
+      source: "AAAI 2023"
+      github: https://github.com/THU-LYJ-Lab/DarkFeat
+      paper: null
+      project: null
+      display: true
   sift:
     matcher: NN-mutual
     feature: sift
     dense: false
+    info:
+      name: SIFT #dispaly name
+      source: "IJCV 2004"
+      github: null
+      paper: https://www.cs.ubc.ca/~lowe/papers/ijcv04.pdf
+      project: null
+      display: true
   gluestick:
     matcher: gluestick
     dense: true
+    info:
+      name: GlueStick #dispaly name
+      source: "ICCV 2023"
+      github: https://github.com/cvg/GlueStick
+      paper: https://arxiv.org/abs/2304.02008
+      project: https://iago-suarez.com/gluestick
+      display: true
   sold2:
     matcher: sold2
     dense: true
+    info:
+      name: SOLD2 #dispaly name
+      source: "CVPR 2021"
+      github: https://github.com/cvg/SOLD2
+      paper: https://arxiv.org/abs/2104.03362
+      project: null
+      display: true