Create README.md

README.md

@@ -0,0 +1,20 @@
+---
+license: mit
+library_name: image-matching-models
+---
+
+
+## Usage
+
+```python
+from imm import get_matcher
+
+matcher = get_matcher("patch2pix", device=device)
+result = matcher(img0, img1)
+# result.keys() = ["num_inliers", "H", "all_kpts0", "all_kpts1", "all_desc0", "all_desc1", "matched_kpts0", "matched_kpts1", "inlier_kpts0", "inlier_kpts1"]
+```
+
+
+## Links
+- [Original repository](https://github.com/vishalsharbidar/SphereGlue)
+- [Image Matching Models](https://github.com/gmberton/image-matching-models)