Improve model card: add paper link, authors, and project info

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +50 -11
README.md CHANGED
@@ -1,28 +1,67 @@
1
  ---
2
- license: apache-2.0
3
- language:
4
- - en
5
  base_model:
6
  - syscv-community/sam-hq-vit-large
 
 
 
7
  pipeline_tag: image-segmentation
 
 
 
 
8
  ---
9
 
10
- # SAMatcher
11
 
12
- SAMatcher is a robust feature matching method that models cross-view co-visibility with Segment Anything (SAM), improving correspondence under viewpoint/illumination/texture changes.
13
 
14
- - GitHub: https://github.com/TwSphinx54/SAMatcher
15
- - Project Page: https://xupan.top/Projects/samatcher
 
 
16
 
17
  ## Quick Start
18
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
19
  ```bash
20
- huggingface-cli download SSSSSphinx/SAMatcher --local-dir ./SAMatcher
21
  ```
22
 
23
  Then follow the official training/evaluation scripts in the GitHub repository.
24
 
25
- ## Notes
 
 
 
 
 
 
 
 
 
 
26
 
27
- - Recommended Python: 3.12 (if using lockfile setup)
28
- - Main dependencies include PyTorch + CUDA 12.1 and flash-attn
 
 
 
 
 
 
 
1
  ---
 
 
 
2
  base_model:
3
  - syscv-community/sam-hq-vit-large
4
+ language:
5
+ - en
6
+ license: apache-2.0
7
  pipeline_tag: image-segmentation
8
+ tags:
9
+ - feature-matching
10
+ - computer-vision
11
+ - co-visibility
12
  ---
13
 
14
+ # SAMatcher: Co-Visibility Modeling with Segment Anything for Robust Feature Matching
15
 
16
+ SAMatcher is a feature matching framework that formulates correspondence estimation through co-visibility modeling. Built upon the Segment Anything Model (SAM), it introduces a symmetric cross-view interaction mechanism that enables bidirectional feature exchange and cross-view semantic alignment to improve correspondence under large viewpoint, illumination, and scale variations.
17
 
18
+ - **Paper:** [SAMatcher: Co-Visibility Modeling with Segment Anything for Robust Feature Matching](https://huggingface.co/papers/2606.03406)
19
+ - **Authors:** Xu Pan, Qiyuan Ma, Jintao Zhang, He Chen, Xianwei Zheng
20
+ - **GitHub:** [https://github.com/TwSphinx54/SAMatcher](https://github.com/TwSphinx54/SAMatcher)
21
+ - **Project Page:** [https://xupan.top/Projects/samatcher](https://xupan.top/Projects/samatcher)
22
 
23
  ## Quick Start
24
 
25
+ ### Installation
26
+
27
+ The project uses `uv` for dependency management. Recommended Python version is 3.12.
28
+
29
+ ```bash
30
+ # Clone the repository
31
+ git clone https://github.com/TwSphinx54/SAMatcher.git
32
+ cd SAMatcher
33
+
34
+ # Install dependencies using uv
35
+ uv sync --frozen
36
+ ```
37
+
38
+ ### Download Weights
39
+
40
+ You can download the model weights using the Hugging Face CLI:
41
+
42
  ```bash
43
+ huggingface-cli download SSSSphinx/SAMatcher --local-dir ./weights/SAMatcher
44
  ```
45
 
46
  Then follow the official training/evaluation scripts in the GitHub repository.
47
 
48
+ ## Evaluation
49
+
50
+ To evaluate on MegaDepth, use the provided script:
51
+
52
+ ```bash
53
+ bash scripts/evaluate_megadepth.sh
54
+ ```
55
+
56
+ ## Citation
57
+
58
+ If you find SAMatcher useful in your research, please consider citing:
59
 
60
+ ```bibtex
61
+ @article{pan2024samatcher,
62
+ title={SAMatcher: Co-Visibility Modeling with Segment Anything for Robust Feature Matching},
63
+ author={Pan, Xu and Ma, Qiyuan and Zhang, Jintao and Chen, He and Zheng, Xianwei},
64
+ journal={arXiv preprint arXiv:2606.03406},
65
+ year={2024}
66
+ }
67
+ ```