Skip to content

Update Model Card for Encoder Decoder Model#39272

Merged
stevhliu merged 15 commits intohuggingface:mainfrom
ParagEkbote:Update-Encoder-Decoder-Card
Jul 11, 2025
Merged

Update Model Card for Encoder Decoder Model#39272
stevhliu merged 15 commits intohuggingface:mainfrom
ParagEkbote:Update-Encoder-Decoder-Card

Conversation

@ParagEkbote
Copy link
Copy Markdown
Contributor

@ParagEkbote ParagEkbote commented Jul 8, 2025 •
edited
Loading

What does this PR do?

As described in the issue, this PR updates the model card for the encoder decoder model with an additional translation example. I have also re-added the contributor names for the Mamba and Mamba-2 models which were previously removed by me. Please let me know if any modifications are required and I will make the necessary changes.

Fixes #8944
Refs #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

@stevhliu stevhliu mentioned this pull request Jul 8, 2025
Closed
stevhliu
stevhliu reviewed Jul 9, 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 working on this one!

Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/mamba.md Outdated
@ParagEkbote ParagEkbote requested a review from stevhliu July 10, 2025 09:40
stevhliu
stevhliu reviewed Jul 10, 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.

Nice job, just a few more things!

Comment thread docs/source/en/model_doc/mamba.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md Outdated
Comment thread docs/source/en/model_doc/encoder-decoder.md
ParagEkbote and others added 3 commits July 11, 2025 11:14
@ParagEkbote ParagEkbote requested a review from stevhliu July 11, 2025 06:05
stevhliu
stevhliu reviewed Jul 11, 2025
View reviewed changes
Comment thread docs/source/en/model_doc/encoder-decoder.md

[`EncoderDecoderModel`] can be randomly initialized from an encoder and a decoder config. In the following example, we show how to do this using the default [`BertModel`] configuration for the encoder and the default [`BertForCausalLM`] configuration for the decoder.
</hfoption>
<hfoption id="AutoModel">
Copy link
Copy Markdown
Member

@stevhliu stevhliu Jul 11, 2025

Choose a reason for hiding this comment

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

The AutoModel example should be unchanged from the last review except for adding attn_implementation=sdpa so that it's aligned with the Pipeline example to show how users can achieve the same thing using the two separate APIs.

This translation example here in the AutoModel section should update the translation example in the ## Notes (which doesn't work by the way).

Copy link
Copy Markdown
Contributor Author

@ParagEkbote ParagEkbote Jul 11, 2025

Choose a reason for hiding this comment

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

I have updated the example. Could you please review?

stevhliu
stevhliu approved these changes Jul 11, 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.

Looks good, thanks!

@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

HuggingFaceDocBuilderDev commented Jul 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 stevhliu merged commit 5c30f7e into huggingface:main Jul 11, 2025
15 checks passed
@ParagEkbote ParagEkbote deleted the Update-Encoder-Decoder-Card branch July 11, 2025 18:24
rjgleaton pushed a commit to rjgleaton/transformers that referenced this pull request Jul 17, 2025
@ParagEkbote @stevhliu @rjgleaton
Update Model Card for Encoder Decoder Model (huggingface#39272)
99e6b15 
* update model card.

* add back the model contributors for mamba and mamba2.

* update the model card.

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* update batches with correct alignment.

* update examples and remove quantization example.

* update the examples.

* Apply suggestions from code review

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

* update example.

* correct the example.

---------

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
@ParagEkbote @stevhliu @zaristei
Update Model Card for Encoder Decoder Model (huggingface#39272)
ef39df9 
* update model card.

* add back the model contributors for mamba and mamba2.

* update the model card.

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* update batches with correct alignment.

* update examples and remove quantization example.

* update the examples.

* Apply suggestions from code review

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

* update example.

* correct the example.

---------

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
@ParagEkbote @stevhliu @zaristei
Update Model Card for Encoder Decoder Model (huggingface#39272)
c317a64 
* update model card.

* add back the model contributors for mamba and mamba2.

* update the model card.

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* update batches with correct alignment.

* update examples and remove quantization example.

* update the examples.

* Apply suggestions from code review

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

* update example.

* correct the example.

---------

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
@ParagEkbote @stevhliu @zaristei
Update Model Card for Encoder Decoder Model (huggingface#39272)
e1ca630 
* update model card.

* add back the model contributors for mamba and mamba2.

* update the model card.

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* update batches with correct alignment.

* update examples and remove quantization example.

* update the examples.

* Apply suggestions from code review

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

* update example.

* correct the example.

---------

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
@ParagEkbote @stevhliu @zaristei
Update Model Card for Encoder Decoder Model (huggingface#39272)
040a159 
* update model card.

* add back the model contributors for mamba and mamba2.

* update the model card.

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* update batches with correct alignment.

* update examples and remove quantization example.

* update the examples.

* Apply suggestions from code review

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

* update example.

* correct the example.

---------

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
@ParagEkbote @stevhliu @zaristei
Update Model Card for Encoder Decoder Model (huggingface#39272)
dff4ac0 
* update model card.

* add back the model contributors for mamba and mamba2.

* update the model card.

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* update batches with correct alignment.

* update examples and remove quantization example.

* update the examples.

* Apply suggestions from code review

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

* update example.

* correct the example.

---------

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
@ParagEkbote @stevhliu @zaristei
Update Model Card for Encoder Decoder Model (huggingface#39272)
9eeb699 
* update model card.

* add back the model contributors for mamba and mamba2.

* update the model card.

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* update batches with correct alignment.

* update examples and remove quantization example.

* update the examples.

* Apply suggestions from code review

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

* update example.

* correct the example.

---------

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
@ParagEkbote @stevhliu @zaristei
Update Model Card for Encoder Decoder Model (huggingface#39272)
9442340 
* update model card.

* add back the model contributors for mamba and mamba2.

* update the model card.

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* update batches with correct alignment.

* update examples and remove quantization example.

* update the examples.

* Apply suggestions from code review

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

* update example.

* correct the example.

---------

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.

how to use EncoderDecoderModel to do en-de translation?

3 participants

@ParagEkbote @HuggingFaceDocBuilderDev @stevhliu