update: rename common -> ui (#47)

* update: rename common -> ui

* update: rename common -> ui

* update: disable sfd2

.github/workflows/format.yml

@@ -19,6 +19,6 @@ jobs:
           cache: 'pip'
       - run: python -m pip install --upgrade pip
       - run: python -m pip install .[dev]
-      - run: python -m flake8 common/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py 
-      - run: python -m isort common/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py --check-only --diff
-      - run: python -m black common/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py --check --diff
+      - run: python -m flake8 ui/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py 
+      - run: python -m isort ui/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py --check-only --diff
+      - run: python -m black ui/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py --check --diff

README.md

@@ -101,7 +101,7 @@ then open http://localhost:7860 in your browser.
 
 ### Add your own feature / matcher
 
-I provide an example to add local feature in [hloc/extractors/example.py](hloc/extractors/example.py). Then add feature settings in `confs` in file [hloc/extract_features.py](hloc/extract_features.py). Last step is adding some settings to `matcher_zoo` in file [common/config.yaml](common/config.yaml).
+I provide an example to add local feature in [hloc/extractors/example.py](hloc/extractors/example.py). Then add feature settings in `confs` in file [hloc/extract_features.py](hloc/extract_features.py). Last step is adding some settings to `matcher_zoo` in file [ui/config.yaml](ui/config.yaml).
 
 ## Contributions welcome!
 

app.py

@@ -1,6 +1,6 @@
 import argparse
 from pathlib import Path
-from common.app_class import ImageMatchingApp
+from ui.app_class import ImageMatchingApp
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser()
@@ -19,7 +19,7 @@
     parser.add_argument(
         "--config",
         type=str,
-        default=Path(__file__).parent / "common/config.yaml",
+        default=Path(__file__).parent / "ui/config.yaml",
         help="config file",
     )
     args = parser.parse_args()

format.sh

@@ -1,3 +1,3 @@
-python -m flake8 common/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py 
-python -m isort common/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py
-python -m black common/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py
+python -m flake8 ui/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py 
+python -m isort ui/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py
+python -m black ui/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py

hloc/matchers/imp.py

@@ -4,7 +4,7 @@
 
 import torch
 
-from .. import device, logger
+from .. import DEVICE, logger
 from ..utils.base_model import BaseModel
 
 pram_path = Path(__file__).parent / "../../third_party/pram"
@@ -34,7 +34,7 @@ class IMP(BaseModel):
     def _init(self, conf):
         self.conf = {**self.default_conf, **conf}
         weight_path = pram_path / "weights" / self.conf["model_name"]
-        self.net = GML(self.conf).eval().to(device)
+        self.net = GML(self.conf).eval().to(DEVICE)
         self.net.load_state_dict(
             torch.load(weight_path, map_location="cpu")["model"], strict=True
         )

pyproject.toml

@@ -20,10 +20,10 @@ dynamic = ["dependencies"]
 dev = ["black", "flake8", "isort"]
 
 [tool.setuptools.packages.find]
-include = ["hloc*",  "common",]
+include = ["hloc*",  "ui",]
 
 [tool.setuptools.package-data]
-common = ["*.yaml"]
+ui = ["*.yaml"]
 
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements.txt"]}

test_app_cli.py

@@ -3,13 +3,13 @@
 import numpy as np
 from pathlib import Path
 from hloc import logger
-from common.utils import (
+from ui.utils import (
     get_matcher_zoo,
     load_config,
     DEVICE,
     ROOT,
 )
-from common.api import ImageMatchingAPI
+from ui.api import ImageMatchingAPI
 
 
 def test_all(config: dict = None):
@@ -109,6 +109,6 @@ def test_one():
 
 
 if __name__ == "__main__":
-    config = load_config(ROOT / "common/config.yaml")
+    config = load_config(ROOT / "ui/config.yaml")
     test_one()
     test_all(config)

common/api.py → ui/api.py

@@ -289,5 +289,5 @@ def visualize(
 
 
 if __name__ == "__main__":
-    config = load_config(ROOT / "common/config.yaml")
+    config = load_config(ROOT / "ui/config.yaml")
     api = ImageMatchingAPI(config)

common/app_class.py → ui/app_class.py

@@ -4,7 +4,7 @@
 import gradio as gr
 import numpy as np
 
-from common.utils import (
+from ui.utils import (
     GRADIO_VERSION,
     gen_examples,
     generate_warp_images,

common/config.yaml → ui/config.yaml

@@ -370,11 +370,11 @@ matcher_zoo:
       display: true
 
   sfd2+imp:
+    enable: false
+    skip_ci: true
     matcher: imp
     feature: sfd2
-    enable: false
     dense: false
-    skip_ci: true
     info:
       name: SFD2+IMP #dispaly name
       source: "CVPR 2023"
@@ -384,11 +384,11 @@ matcher_zoo:
       display: true
 
   sfd2+mnn:
+    enable: false
+    skip_ci: true
     matcher: NN-mutual
     feature: sfd2
-    enable: false
     dense: false
-    skip_ci: true
     info:
       name: SFD2+MNN #dispaly name
       source: "CVPR 2023"