Update SuperPoint model card #38896
Update SuperPoint model card #38896
Conversation
|
@stevhliu Still a first draft, how is it possible to see the formatted result ? |
| traditional corner detector. The final system gives rise to state-of-the-art homography estimation results on HPatches | ||
| when compared to LIFT, SIFT and ORB.* | ||
| > [!TIP] | ||
| > Click on the SuperPoint models in the right sidebar for more examples of how to apply SuperPoint to different computer vision tasks. | ||
|
|
||
| <img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/superpoint_architecture.png" |
There was a problem hiding this comment.
Let's move the image right after the first paragraph
| @@ -117,12 +115,18 @@ plt.savefig(f"output_image.png") | |||
| ``` | |||
|  | |||
|
|
|||
| ## Resources | |||
|
|
|||
| The resources provided in the following sections consist of a list of official Hugging Face and community (indicated by 🌎) resources to help you get started with SuperPoint. If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. | |||
There was a problem hiding this comment.
Replace all the resources with only external links:
Refer to this [noteboook](https://github.com/NielsRogge/Transformers-Tutorials/blob/master/SuperPoint/Inference_with_SuperPoint_to_detect_interest_points_in_an_image.ipynb) for an inference and visualization example.| <PipelineTag pipeline="keypoint-detection"/> | ||
|
|
||
| - [`SuperPointForKeypointDetection`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/vision) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/keypoint_detection.ipynb). | ||
| - Check the [Keypoint detection task guide](../tasks/keypoint_detection) on how to use the model. |
| @@ -132,13 +136,12 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h | |||
|
|
|||
| ## SuperPointImageProcessor | |||
|
|
|||
| [[autodoc]] SuperPointImageProcessor | |||
There was a problem hiding this comment.
No need to change any of these [[autodoc]] classes here
I can run the |
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
|
@stevhliu addressed your comments, although I kept the line since the task exist I think it should be referred to somewhere even if there is no pipeline no ? |
I don't think the task guide adds any additional information that your model card doesn't already include so it seems a bit redundant to link to that guide. |
|
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. |
What does this PR do?
Updates SuperPoint model card for #36979
Before submitting
Who can review?
@stevhliu