SuperPointModel -> SuperPointForKeypointDetection#29757
SuperPointModel -> SuperPointForKeypointDetection#29757amyeroberts merged 1 commit intohuggingface:mainfrom
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
|
cc @sbucaille As you're working on adding SuperGlue - and apologies for my previous bad advise to just use AutoModel! |
|
Thanks @amyeroberts for the quick fix - one minor remark is that I would've waited with adding an |
|
Yes, but in this case it's needed for the SuperGlue implementation |
|
Could you clarify why it's needed? Models can be added to the "not auto mapped" list and eventually be added to an auto class |
|
Because we need an auto model to be used within the modeling file for SuperPoint, similar to what we do in llava |
|
@amyeroberts I was exactly about to point the problem I would reach with SuperGlue, since it uses the outputs of models like SuperPoint (keypoints data) and not images (pixel_values). But we will be able to discuss this in the appropriate PR (btw you can reopen it as I'll push new changes in the coming days). Anyway thanks for the anticipation ! 🤗 |
What does this PR do?
Renames
SuperPointModeltoSuperPointForKeypointDetectionand addsAutoModelForKeypointDetection. This is more in-line with our library's pattern, whereAutoModelreturns a base model andAutoModelForXxxwill return task specific outputs.Originally I had requested this, as the model doesn't have an obvious task-specific head on-top. @NielsRogge highlighted the discrepancy and it was agreed offline using the task-specific class was better.
There is currently no
SuperPointModelclass, but we can add this later if neededFixes # (issue)
Before submitting
Pull Request section?
to it if that's the case.
documentation guidelines, and
here are tips on formatting docstrings.
Who can review?
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.