Skip to content

chore: update SigLIP2 model card #37624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 12 commits into from
Apr 25, 2025
Merged

chore: update SigLIP2 model card #37624

merged 12 commits into from
Apr 25, 2025

Conversation

saswatmeher
Copy link
Contributor

What does this PR do?

Update the model card for SigLIP2 to handle #36979

Fixes #36979

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

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.

Documentation: @stevhliu

@github-actions github-actions bot marked this pull request as draft April 19, 2025 04:35
@github-actions GitHub Actions
Copy link
Contributor

Hi 👋, thank you for opening this pull request! The pull request is converted to draft by default. The CI will be paused while the PR is in draft mode. When it is ready for review, please click the Ready for review button (at the bottom of the PR page). This will assign reviewers and trigger CI.

@saswatmeher saswatmeher marked this pull request as ready for review April 19, 2025 04:43
@github-actions github-actions bot requested a review from stevhliu April 19, 2025 04:43
stevhliu
stevhliu reviewed Apr 22, 2025
View reviewed changes
Copy link
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! :)

docs/source/en/model_doc/siglip2.md
15.0% that image 0 is '2 cats'
logits_per_image = outputs.logits_per_image
probs = torch.sigmoid(logits_per_image)
print(f"{probs[0][0]:.1%} that image 0 is '{candidate_labels[0]}'")
Copy link
Member

Choose a reason for hiding this comment

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

Let's also add the NaFlex example in the <hfoption id="AutoModel"> block too

<hfoption id="AutoModel">

FixRes example
NaFlex example

</hfoption>
</hfoptions>

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tried something similar to Llama4 README. created separate tabs for NaFlex and FixRes variants. Have a look at it. Let me know if it works or not.

Copy link
Member

Choose a reason for hiding this comment

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

Oh thats a really good idea! 👍

stevhliu
stevhliu approved these changes Apr 24, 2025
View reviewed changes
Copy link
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.

Awesome, thanks for your work! We can merge after a few more minor nits :)

docs/source/en/model_doc/siglip2.md
15.0% that image 0 is '2 cats'
logits_per_image = outputs.logits_per_image
probs = torch.sigmoid(logits_per_image)
print(f"{probs[0][0]:.1%} that image 0 is '{candidate_labels[0]}'")
Copy link
Member

Choose a reason for hiding this comment

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

Oh thats a really good idea! 👍

@HuggingFaceDocBuilderDev
Copy link

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.

@saswatmeher
Copy link
Contributor Author

Addressed. Thank you for your suggestions! :)

@stevhliu stevhliu merged commit 57c620b into huggingface:main Apr 25, 2025
10 checks passed
@stevhliu stevhliu mentioned this pull request Apr 25, 2025
Open
zucchini-nlp pushed a commit to zucchini-nlp/transformers that referenced this pull request May 14, 2025
@saswatmeher @stevhliu @zucchini-nlp
chore: update SigLIP2 model card (huggingface#37624)
216bec1 
* update siglip2 model card

* Update docs/source/en/model_doc/siglip2.md

Co-authored-by: Steven Liu <[email protected]>

* Update docs/source/en/model_doc/siglip2.md

Co-authored-by: Steven Liu <[email protected]>

* Update docs/source/en/model_doc/siglip2.md

Co-authored-by: Steven Liu <[email protected]>

* Update docs/source/en/model_doc/siglip2.md

Co-authored-by: Steven Liu <[email protected]>

* Update docs/source/en/model_doc/siglip2.md

Co-authored-by: Steven Liu <[email protected]>

* Update docs/source/en/model_doc/siglip2.md

Co-authored-by: Steven Liu <[email protected]>

* address comments

* separate naflex and fixres variant

* Update docs/source/en/model_doc/siglip2.md

Co-authored-by: Steven Liu <[email protected]>

* Update docs/source/en/model_doc/siglip2.md

Co-authored-by: Steven Liu <[email protected]>

* Update docs/source/en/model_doc/siglip2.md

Co-authored-by: Steven Liu <[email protected]>

---------

Co-authored-by: Steven Liu <[email protected]>
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.

[Community contributions] Model cards
3 participants
@saswatmeher @HuggingFaceDocBuilderDev @stevhliu