[Community contributions] Model cards #36979

stevhliu · 2025-03-25T20:39:10Z

Hey friends! 👋

We are currently in the process of improving the Transformers model cards by making them more directly useful for everyone. The main goal is to:

Standardize all model cards with a consistent format so users know what to expect when moving between different model cards or trying to learn how to use a new model.
Include a brief description of the model (what makes it unique/different) written in a way that's accessible to everyone.
Provide ready to use code examples featuring the Pipeline, AutoModel, and transformers-cli with available optimizations included. For large models, provide a quantization example so its easier for everyone to run the model.
Include an attention mask visualizer for currently supported models to help users visualize what a model is seeing (refer to Add attention visualization tool #36630) for more details.

Compare the before and after model cards below:

With so many models in Transformers, we could really use some a hand with standardizing the existing model cards. If you're interested in making a contribution, pick a model from the list below and then you can get started!

Steps

Each model card should follow the format below. You can copy the text exactly as it is!

# add appropriate badges
<div style="float: right;">
    <div class="flex flex-wrap space-x-1">
           <img alt="" src="" >
    </div>
</div>

# Model name

[Model name](https://huggingface.co/papers/...) ...

A brief description of the model and what makes it unique/different. Try to write this like you're talking to a friend. 

You can find all the original [Model name] checkpoints under the [Model name](link) collection.

> [!TIP]
> Click on the [Model name] models in the right sidebar for more examples of how to apply [Model name] to different [insert task types here] tasks.

The example below demonstrates how to generate text based on an image with [`Pipeline`] or the [`AutoModel`] class.

<hfoptions id="usage">
<hfoption id="Pipeline>

insert pipeline code here

</hfoption>
<hfoption id="AutoModel">

add AutoModel code here

</hfoption>
<hfoption id="transformers-cli">

add transformers-cli usage here if applicable/supported, otherwise close the hfoption block

</hfoption>
</hfoptions

Quantization reduces the memory burden of large models by representing the weights in a lower precision. Refer to the [Quantization](../quantization/overview) overview for more available quantization backends.

The example below uses [insert quantization method here](link to quantization method) to only quantize the weights to __.

# add if this is supported for your model
Use the [AttentionMaskVisualizer](https://github.com/huggingface/transformers/blob/beb9b5b02246b9b7ee81ddf938f93f44cfeaad19/src/transformers/utils/attention_visualizer.py#L139) to better understand what tokens the model can and cannot attend to.

\```py
from transformers.utils.attention_visualizer import AttentionMaskVisualizer

visualizer = AttentionMaskVisualizer("google/gemma-3-4b-it")
visualizer("<img>What is shown in this image?")
\```

# upload image to https://huggingface.co/datasets/huggingface/documentation-images/tree/main/transformers/model_doc and ping me to merge
<div class="flex justify-center">
    <img src=""/>
</div>

## Notes

- Any other model-specific notes should go here.

   \```py
    <insert relevant code snippet here related to the note if its available>
   \ ```

For examples, take a look at #36469 or the BERT, Llama, Llama 2, Gemma 3, PaliGemma, ViT, and Whisper model cards on the main version of the docs.

Once you're done or if you have any questions, feel free to ping @stevhliu to review. Don't add fix to your PR to avoid closing this issue.

I'll also be right there working alongside you and opening PRs to convert the model cards so we can complete this faster together! 🤗

Models

The text was updated successfully, but these errors were encountered:

devesh-2002 · 2025-03-26T03:47:54Z

Hi. I would like to work on model card for gemma 2.

NahieliV · 2025-03-26T12:55:53Z

Hi. I would like to work on model card for mistral.

NahieliV · 2025-03-26T22:10:17Z

Hi @stevhliu , this is my first contribution so I have a really basic question . Should I clone every repo under mistralai? I just cloned the repo mistralai/Ministral-8B-Instruct-2410, but there are many other repos under mistralai. It's ok if I need to, but I just want to be sure.

capnmav77 · 2025-03-26T23:43:21Z

Hey , I would like to work on the model card for llama3 .

stevhliu · 2025-03-27T00:28:55Z

Hey @NahieliV, welcome! You only need to modify the mistral.md file. This is just for the model cards in the Transformers docs rather than the Hub.

arkhamHack · 2025-03-27T15:05:43Z

Hey @stevhliu I would like to work on the model card for qwen2_5_vl.

hesamsheikh · 2025-03-27T15:41:01Z

@stevhliu Is it not possible to automate with an LLM?

AbhishekRP2002 · 2025-03-27T15:54:51Z

hi @stevhliu i would be super grateful if you can let me work on the model card for code_llama

bimal-gajera · 2025-03-27T17:00:08Z

Hey @stevhliu, I would like to work on the cohere model card.

ash-01xor · 2025-03-27T17:19:12Z

Hey @stevhliu , i would like to contribute to gpt2 model card

saumanraaj · 2025-03-27T20:25:47Z

Hey @stevhliu , I would like to contribute to vitpose model card

Wu-n0 · 2025-03-28T03:06:34Z

Hey @stevhliu, I would like to work on the electra model card

shubham0204 · 2025-03-28T06:29:30Z

@stevhliu I will update the model card for depth_anything.
PR: #37065

darmasrmez · 2025-03-28T17:58:12Z

Hey @stevhliu , I would like to contribute to mixtral model card

ash-01xor · 2025-03-29T06:44:00Z

To the folks who have been raising PR so far , just have a doubt did you get to install flax , tf-keras , sentencepiece etc.
Before making the changes, I'm trying to set up the environment following the steps here: https://github.com/huggingface/transformers/tree/main/docs.
Currently, I'm trying to build the documentation, but I repeatedly encounter errors such as Unable to register cuDNN factory: and the library installation errors. So would like to know if I am missing any steps or if all these library installations are necessary for making the changes

EDIT : Got it up and running, had to install all the libraries to make it run successfully. Initially felt doubtful about the need to install all the libraries such as flax but yea seems like it has to be installed too.

arpitsinghgautam · 2025-03-29T06:44:24Z

Hey @stevhliu, I would like to work on the phi3 model card

shubham0204 · 2025-03-29T07:01:33Z

To the folks who have been raising PR so far , just have a doubt did you get to install flax , tf-keras , sentencepiece etc. Before making the changes, I'm trying to set up the environment following the steps here: https://github.com/huggingface/transformers/tree/main/docs. Currently, I'm trying to build the documentation, but I repeatedly encounter errors such as Unable to register cuDNN factory: and the library installation errors. So would like to know if I am missing any steps or if all these library installations are necessary for making the changes

As you just going to edit the docs, you need not have a complete development setup. Fork the transformers repo, checkout a new branch, and start updating the Markdown document of your choice in the docs/source/en/model_doc directory.

Shoumik-Gandre · 2025-05-03T20:29:42Z

Hey @stevhliu I have made the suggested changes to deberta - #37409

Apologies for the wait. Busy month.

BryanBradfo · 2025-05-03T20:50:35Z

Hi @stevhliu,

Continuing with the model card updates, I would like to work on the following models next:

pixtral
shieldgemma2

Please let me know if these are still available and okay for me to take on. Thanks!

KsuParkhamchuk · 2025-05-04T01:00:14Z

Hello @stevhliu, worked on RoFormer card update in #37946
Please let me know if any adjustments needed from my side, thanks

RogerSinghChugh · 2025-05-05T12:25:26Z

Hi @stevhliu, have created a PR(#37959) for BigBird.
Please let me know if I need to make any changes. Thanks a lot.

RogerSinghChugh · 2025-05-06T16:25:32Z

Hi @stevhliu, continuing on my work I would love to update the BERTweet model card too, will raise a PR asap.
Thanks.

RogerSinghChugh · 2025-05-06T16:28:42Z

Hi @stevhliu, continuing on my work I would love to update the BERTweet model card too, will raise a PR asap. Thanks.

@stevhliu I have created a PR for BERTweet in #37981. Please let me know if I need to make any changes. Thanks a lot.

GSNCodes · 2025-05-07T01:16:06Z

Hey @stevhliu ,
I'd like to take up Segformer :)

1himan · 2025-05-12T05:18:55Z

Hello @stevhliu, I've created a PR for ALIGN(the top 2nd model on the list). This is the one.

alvarotorro · 2025-05-13T18:36:44Z

Hi @stevhliu, I initially started with bartpho but it already has a model card. I would now like to contribute the model card for gemma, which I confirmed is implemented and currently undocumented.

1himan · 2025-05-14T09:54:06Z

What is happening? Nobody's reviewing our PRs and merging them in the main codebase, it has been days since @stevhliu was actively reviewing our PRs? Is there anyone else in the community who can do the reviewing instead of him?

* Update code_llama.md aims to handle huggingface#36979 (comment) sub part of huggingface#36979 * Update docs/source/en/model_doc/code_llama.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/code_llama.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/code_llama.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * make changes as per code review * chore: make the function smaller for attention mask visualizer * chore[docs]: update code_llama.md with some more suggested changes * Update docs/source/en/model_doc/code_llama.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * chore[docs] : Update code_llama.md with indentation changes --------- Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

mreraser · 2025-05-15T03:21:49Z

Hi everyone! I'd love to contribute as well. Is anyone currently working on vit_mae? If not, I'd be happy to take it on.

udapy · 2025-05-17T22:42:12Z

Hi @stevhliu,
I would like to work on smolvlm model card.
Thanks.

Aguedoom · 2025-05-19T17:44:20Z

Hi everyone and @stevhliu, I'm actually working on BioGPT, I would like to claim it, thanks.

stevhliu · 2025-05-20T23:39:52Z

Hey friends, sorry for the delay, I was on vacation but I'm back now and will be working on reviewing all your PRs over the next few days. Thanks for your patience! 🤗

@alvarotorro, bartpho doesn't look like it has been standardized yet whereas gemma has. Would you still like to work on bartpho?

sezan92 · 2025-05-22T05:41:16Z

Hello i want to take the cvt model card if it is okay

EmileAydar · 2025-05-22T19:17:12Z

Hi @stevhliu , I'd like to work on the altclip model card.

stevhliu added contributions-welcome Good First Documentation Issue Good First Issue labels Mar 25, 2025

stevhliu pinned this issue Mar 25, 2025

purusharthmalik mentioned this issue Mar 27, 2025

Updated the model card for CLIP #37040

Merged

ParagEkbote mentioned this issue Mar 27, 2025

Update Model Card for ModernBERT #37052

Merged

1 task

bimal-gajera mentioned this issue Mar 28, 2025

Update model card for Cohere #37056

Merged

1 task

Wu-n0 mentioned this issue Mar 28, 2025

Update model card for electra #37063

Merged

1 task

shubham0204 mentioned this issue Mar 28, 2025

Update model card for Depth Anything #37065

Merged

1 task

devesh-2002 mentioned this issue Mar 28, 2025

Improvements in Gemma2 model card #37076

Merged

5 tasks

arkhamHack mentioned this issue Mar 29, 2025

feat: updated model card for qwen_2.5_vl #37099

Merged

5 tasks

ash-01xor mentioned this issue Mar 29, 2025

Update Model card for GPT2 #37101

Merged

4 tasks

shubham0204 mentioned this issue Mar 29, 2025

Update model-card for DINOv2 #37104

Merged

1 task

BryanBradfo mentioned this issue May 3, 2025

docs(swinv2): Update SwinV2 model card to new standard format #37942

Open

5 tasks

KsuParkhamchuk mentioned this issue May 4, 2025

[docs]: update roformer.md model card #37946

Open

1 task

yuanjua added a commit to yuanjua/transformers that referenced this issue May 4, 2025

update model card with new style huggingface#36979

8c6f063

yuanjua added a commit to yuanjua/transformers that referenced this issue May 4, 2025

doc: huggingface#36979

ee24e47

yuanjua added a commit to yuanjua/transformers that referenced this issue May 4, 2025

update style huggingface#36979

dae1243

yuanjua mentioned this issue May 4, 2025

Model card for mobilenet v1 and v2 #37948

Open

5 tasks

ParagEkbote mentioned this issue May 4, 2025

Update Model Card for Mamba-2 #37951

Open

1 task

RogerSinghChugh added a commit to RogerSinghChugh/transformers that referenced this issue May 5, 2025

Updated BigBird Model card as per huggingface#36979.

71155f3

RogerSinghChugh mentioned this issue May 5, 2025

Updated BigBird Model card as per #36979. #37959

Draft

5 tasks

RogerSinghChugh mentioned this issue May 6, 2025

Updated BERTweet model card. #37981

Draft

5 tasks

Aguedoom mentioned this issue May 19, 2025

Update BioGPT model card #38214

Open

5 tasks

mreraser mentioned this issue May 22, 2025

Updated the model card for ViTMAE #38302

Open

4 tasks

EmileAydar mentioned this issue May 22, 2025

Update altCLIP model card #38306

Open

[Community contributions] Model cards #36979

[Community contributions] Model cards #36979

Comments

stevhliu commented Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Steps

Models

devesh-2002 commented Mar 26, 2025

Uh oh!

NahieliV commented Mar 26, 2025

Uh oh!

NahieliV commented Mar 26, 2025

Uh oh!

capnmav77 commented Mar 26, 2025

Uh oh!

stevhliu commented Mar 27, 2025

Uh oh!

arkhamHack commented Mar 27, 2025

Uh oh!

hesamsheikh commented Mar 27, 2025

Uh oh!

AbhishekRP2002 commented Mar 27, 2025

Uh oh!

bimal-gajera commented Mar 27, 2025

Uh oh!

ash-01xor commented Mar 27, 2025

Uh oh!

saumanraaj commented Mar 27, 2025

Uh oh!

Wu-n0 commented Mar 28, 2025

Uh oh!

shubham0204 commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

darmasrmez commented Mar 28, 2025

Uh oh!

ash-01xor commented Mar 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

arpitsinghgautam commented Mar 29, 2025

Uh oh!

shubham0204 commented Mar 29, 2025

Uh oh!

Shoumik-Gandre commented May 3, 2025

Uh oh!

BryanBradfo commented May 3, 2025

Uh oh!

KsuParkhamchuk commented May 4, 2025

Uh oh!

RogerSinghChugh commented May 5, 2025

Uh oh!

RogerSinghChugh commented May 6, 2025

Uh oh!

RogerSinghChugh commented May 6, 2025

Uh oh!

GSNCodes commented May 7, 2025

Uh oh!

1himan commented May 12, 2025

Uh oh!

alvarotorro commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

1himan commented May 14, 2025

Uh oh!

mreraser commented May 15, 2025

Uh oh!

udapy commented May 17, 2025

Uh oh!

Aguedoom commented May 19, 2025

Uh oh!

stevhliu commented May 20, 2025

Uh oh!

sezan92 commented May 22, 2025

Uh oh!

EmileAydar commented May 22, 2025

Uh oh!

stevhliu commented Mar 25, 2025 •

edited

Loading

shubham0204 commented Mar 28, 2025 •

edited

Loading

ash-01xor commented Mar 29, 2025 •

edited

Loading

alvarotorro commented May 13, 2025 •

edited

Loading