Update altCLIP model card #38306

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

stevhliu merged 11 commits into huggingface:main from EmileAydar:main

Jun 11, 2025

Contributor

EmileAydar commented May 22, 2025

What does this PR do?

As suggested in this issue - #36979 (comment) - this PR rewrites the altCLIP model card so it matches the standardized template that @stevhliu introduced in #36979.

Key points:

Friend-style overview + sidebar badges.
usage tabs — Pipeline tab explains why it’s missing, AutoModel tab contains a runnable similarity example, transformers-cli tab shows one-liner quantisation.
Quantisation section with dynamic INT-8 snippet (Linear-only, Embeddings left FP32) and link to the Quantization guide.
Attention visualisation section: explains current AttentionMaskVisualizer limitation and shows a manual ViT-attention workaround; embeds a PNG heat-map (CLS attention, last layer, head
All text follows Steve’s template verbatim where required.

Check list

[DONE] Brief model description
[ DONE] Ready-to-use code examples (Pipeline ✗, AutoModel ✓, transformers-cli ✓)
[ DONE] Quantisation example for a large model (dynamic INT-8)
[DONE ] Attention mask visualiser (note + workaround ) # I did not provide an image because it is not produced from the HF visualizer, but I can if required.

Who can review?

I updated the altCLIP model card following the standard format.

Let me know what you think of it.

Happy to revise. Thanks!

stevhliu mentioned this pull request

[Community contributions] Model cards #36979

Closed

stevhliu reviewed

View reviewed changes

Member

stevhliu left a comment

Thanks, added some suggestions to make it simpler!

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated

Comment on lines 58 to 68

    
              <hfoption id="transformers-cli">

              ```python

              >>> from PIL import Image

              >>> import requests

              altCLIP does **not** require `transformers-cli` at inference time, but the tool is handy for quantisation (see next section).

              >>> from transformers import AltCLIPModel, AltCLIPProcessor

              </hfoption>

Member

stevhliu May 27, 2025

Remove this as well since it isn't supported

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated

    
              ---

              [[autodoc]] AltCLIPProcessor

              ## Attention visualisation

Member

stevhliu May 27, 2025

This can be removed since it isn't supported

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

stevhliu reviewed

View reviewed changes

Member

stevhliu left a comment

Thanks, there are still some unresolved comments. You also don't need to modify the other files testing_utils.py and modeling_deit.py.

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

docs/source/en/model_doc/altclip.md Outdated Show resolved Hide resolved

EmileAydar closed this

EmileAydar force-pushed the main branch from 4c64e31 to 1dcb022 Compare

June 11, 2025 19:27


          Update altclip.md

9b1b333

EmileAydar reopened this

EmileAydar and others added 10 commits

June 11, 2025 21:36


          Update altclip.md

2628e1c


          Update altclip.md

9084aa5


          Update altclip.md

49fa7e2


          Update altclip.md

db7fd56


          Update altclip.md

bfd70c3


          Rename altclip.md to altclip.mdx

8f10925


          Rename altclip.mdx to altclip.md

b496cf0


          Update altclip.md

be6de43


          Update altclip.md

b7fc82b


          Update altclip.md

780549d

Contributor Author

EmileAydar commented Jun 11, 2025

Hi @stevhliu,
The checks seem to be all valid now.
Please let me know if you’d like any further tweaks or if you think this is good to go.

HuggingFaceDocBuilderDev commented Jun 11, 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.

stevhliu approved these changes

View reviewed changes

Member

stevhliu left a comment

Thanks!

stevhliu merged commit 32dbf4b into huggingface:main

10 checks passed

lmarshall12 pushed a commit to lmarshall12/transformers that referenced this pull request


          Update altCLIP model card (huggingface#38306)

6afec7d

* Update altclip.md

* Update altclip.md

* Update altclip.md

* Update altclip.md

* Update altclip.md

* Update altclip.md

* Rename altclip.md to altclip.mdx

* Rename altclip.mdx to altclip.md

* Update altclip.md

* Update altclip.md

* Update altclip.md

---------

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

Labels

None yet