Skip to content

Update SuperPoint model card#38896

Merged
stevhliu merged 6 commits intohuggingface:mainfrom
sbucaille:superpoint_doc
Jun 26, 2025
Merged

Update SuperPoint model card#38896
stevhliu merged 6 commits intohuggingface:mainfrom
sbucaille:superpoint_doc

Conversation

@sbucaille
Copy link
Copy Markdown
Contributor

@sbucaille sbucaille commented Jun 18, 2025

What does this PR do?

Updates SuperPoint model card for #36979

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).

Who can review?

@stevhliu

@sbucaille
Copy link
Copy Markdown
Contributor Author

sbucaille commented Jun 18, 2025

@stevhliu Still a first draft, how is it possible to see the formatted result ?

@stevhliu stevhliu mentioned this pull request Jun 18, 2025
Closed
stevhliu
stevhliu reviewed Jun 18, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the model you contributed! ❤️

Comment thread docs/source/en/model_doc/superpoint.md Outdated
Comment thread docs/source/en/model_doc/superpoint.md Outdated
Comment thread docs/source/en/model_doc/superpoint.md
Comment thread docs/source/en/model_doc/superpoint.md Outdated
Comment thread docs/source/en/model_doc/superpoint.md Outdated
> [!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"
Copy link
Copy Markdown
Member

@stevhliu stevhliu Jun 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's move the image right after the first paragraph

Comment thread docs/source/en/model_doc/superpoint.md Outdated
Comment thread docs/source/en/model_doc/superpoint.md Outdated

## 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.
Copy link
Copy Markdown
Member

@stevhliu stevhliu Jun 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/source/en/model_doc/superpoint.md Outdated
Comment on lines +124 to +127
<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.
Copy link
Copy Markdown
Member

@stevhliu stevhliu Jun 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can remove all of this

Comment thread docs/source/en/model_doc/superpoint.md Outdated
Comment thread docs/source/en/model_doc/superpoint.md

## SuperPointImageProcessor

[[autodoc]] SuperPointImageProcessor
Copy link
Copy Markdown
Member

@stevhliu stevhliu Jun 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to change any of these [[autodoc]] classes here

@stevhliu
Copy link
Copy Markdown
Member

stevhliu commented Jun 18, 2025

how is it possible to see the formatted result ?

I can run the build_pr_documentation job to generate a preview

@sbucaille
Copy link
Copy Markdown
Contributor Author

sbucaille commented Jun 19, 2025 •
edited
Loading

@stevhliu addressed your comments, although I kept the line

- Check the [Keypoint detection task guide](../tasks/keypoint_detection) on how to use the model.

since the task exist I think it should be referred to somewhere even if there is no pipeline no ?

@stevhliu
Copy link
Copy Markdown
Member

stevhliu commented Jun 20, 2025

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.

@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

HuggingFaceDocBuilderDev commented Jun 20, 2025

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.

@sbucaille
Copy link
Copy Markdown
Contributor Author

sbucaille commented Jun 23, 2025

@stevhliu indeed, I removed it

stevhliu
stevhliu approved these changes Jun 26, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!

@stevhliu stevhliu merged commit f171e7e into huggingface:main Jun 26, 2025
10 checks passed
@sbucaille sbucaille deleted the superpoint_doc branch July 6, 2025 13:22
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@sbucaille @stevhliu @zaristei
Update SuperPoint model card (huggingface#38896)
f23d72b 
* docs: first draft to more standard SuperPoint documentation

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* docs: reverted changes on Auto classes

* docs: addressed the rest of the comments

* docs: remove outdated reference to keypoint detection task guide in SuperPoint documentation

* Update superpoint.md

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@sbucaille @stevhliu @zaristei
Update SuperPoint model card (huggingface#38896)
a43f2e4 
* docs: first draft to more standard SuperPoint documentation

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* docs: reverted changes on Auto classes

* docs: addressed the rest of the comments

* docs: remove outdated reference to keypoint detection task guide in SuperPoint documentation

* Update superpoint.md

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@sbucaille @stevhliu @zaristei
Update SuperPoint model card (huggingface#38896)
3c244de 
* docs: first draft to more standard SuperPoint documentation

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* docs: reverted changes on Auto classes

* docs: addressed the rest of the comments

* docs: remove outdated reference to keypoint detection task guide in SuperPoint documentation

* Update superpoint.md

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@sbucaille @stevhliu @zaristei
Update SuperPoint model card (huggingface#38896)
f70e382 
* docs: first draft to more standard SuperPoint documentation

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* docs: reverted changes on Auto classes

* docs: addressed the rest of the comments

* docs: remove outdated reference to keypoint detection task guide in SuperPoint documentation

* Update superpoint.md

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@sbucaille @stevhliu @zaristei
Update SuperPoint model card (huggingface#38896)
7ea7230 
* docs: first draft to more standard SuperPoint documentation

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* docs: reverted changes on Auto classes

* docs: addressed the rest of the comments

* docs: remove outdated reference to keypoint detection task guide in SuperPoint documentation

* Update superpoint.md

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@sbucaille @stevhliu @zaristei
Update SuperPoint model card (huggingface#38896)
226ebed 
* docs: first draft to more standard SuperPoint documentation

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* docs: reverted changes on Auto classes

* docs: addressed the rest of the comments

* docs: remove outdated reference to keypoint detection task guide in SuperPoint documentation

* Update superpoint.md

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@sbucaille @stevhliu @zaristei
Update SuperPoint model card (huggingface#38896)
0a5a515 
* docs: first draft to more standard SuperPoint documentation

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* docs: reverted changes on Auto classes

* docs: addressed the rest of the comments

* docs: remove outdated reference to keypoint detection task guide in SuperPoint documentation

* Update superpoint.md

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stevhliu stevhliu stevhliu approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sbucaille @stevhliu @HuggingFaceDocBuilderDev