Skip to content

Commit

Permalink
Fix LightGlue docstring (#109)
Browse files Browse the repository at this point in the history
Docstring for lightglue forward has leftover doc about `log_assignment`,
which is not outputed anymore since refactor, and couple of more outputs
were not documented

Actual output:
https://github.com/cvg/LightGlue/blob/main/lightglue/lightglue.py#L609

---------

Co-authored-by: Paul-Edouard Sarlin <paul.edouard.sarlin@gmail.com>
  • Loading branch information
ducha-aiki and sarlinpe authored Feb 16, 2024
1 parent 058edd8 commit 075ae42
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions lightglue/lightglue.py
Original file line number Diff line number Diff line change
Expand Up @@ -459,12 +459,15 @@ def forward(self, data: dict) -> dict:
descriptors: [B x N x D]
image: [B x C x H x W] or image_size: [B x 2]
Output (dict):
log_assignment: [B x M+1 x N+1]
matches0: [B x M]
matching_scores0: [B x M]
matches1: [B x N]
matching_scores1: [B x N]
matches: List[[Si x 2]], scores: List[[Si]]
matches: List[[Si x 2]]
scores: List[[Si]]
stop: int
prune0: [B x M]
prune1: [B x N]
"""
with torch.autocast(enabled=self.conf.mp, device_type="cuda"):
return self._forward(data)
Expand Down

0 comments on commit 075ae42

Please sign in to comment.