Update model card for electra by Wu-n0 · Pull Request #37063 · huggingface/transformers

Wu-n0 · 2025-03-28T04:34:41Z

What does this PR do?

This PR updates the ELECTRA model card to follow the standardized format outlined in issue #36979. The updated model card includes:

A conversational description of how ELECTRA works and what makes it unique
Code examples for using ELECTRA with both Pipeline and AutoModel
A quantization example for the large model
Detailed usage notes with practical tips

Note: I did not include a transformers-cli example because ELECTRA is a discriminative model for classification tasks rather than text generation, making it less suitable for CLI interaction.

I also couldn't include an AttentionMaskVisualizer example because it's not currently supported with ELECTRA. When attempting to implement it locally, I encountered this error:
AttributeError: '_ModelWrapper' object has no attribute '_update_causal_mask'

Before submitting

This PR fixes a typo or improves the docs

Who can review?

@stevhliu

github-actions · 2025-03-28T04:34:56Z

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.

stevhliu

Nice work, love the Notes section! 🚀 No worries about the AttentionMaskVisualizer which hasn't been implemented for ELECTRA yet.

I think you can include a transformers-cli example for text classification:

echo -e "This restaurant has amazing food." | transformers-cli run --task text-classification --model bhadresh-savani/electra-base-emotion --device 0

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

HuggingFaceDocBuilderDev · 2025-03-31T20:47:12Z

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

One more comment + a few other unresolved comments. Otherwise, we should be ready to merge soon! 👍

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

…transformers into update-electra-model-card

Wu-n0 · 2025-04-03T04:49:51Z

I've implemented all the requested changes.

stevhliu

Thanks! I hope you don't mind I closed one of the <hfoption> blocks for you 😄

* Update ELECTRA model card with new format * Update ELECTRA model card with new format * Update docs/source/en/model_doc/electra.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/electra.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/electra.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/electra.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/electra.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/electra.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/electra.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/electra.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/electra.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * close hfoption block --------- Co-authored-by: Wun0 <f20191221@hyderabad.bits-pilani.ac.in> Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

Update ELECTRA model card with new format

2792fa3

github-actions Bot marked this pull request as draft March 28, 2025 04:34

Wu-n0 marked this pull request as ready for review March 28, 2025 04:43

github-actions Bot requested a review from stevhliu March 28, 2025 04:43

abdulazeem-tk4vr approved these changes Mar 28, 2025

View reviewed changes

abdulazeem-tk4vr reviewed Mar 28, 2025

View reviewed changes

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

abdulazeem-tk4vr suggested changes Mar 28, 2025

View reviewed changes

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

stevhliu mentioned this pull request Mar 28, 2025

[Community contributions] Model cards #36979

Closed

Update ELECTRA model card with new format

fec39c0

stevhliu reviewed Mar 29, 2025

View reviewed changes

Wu-n0 and others added 8 commits March 30, 2025 04:20

Update docs/source/en/model_doc/electra.md

4903de0

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

Update docs/source/en/model_doc/electra.md

b1bc9b9

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

Update docs/source/en/model_doc/electra.md

8524ba7

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

Update docs/source/en/model_doc/electra.md

1db3926

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

Update docs/source/en/model_doc/electra.md

7084017

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

Update docs/source/en/model_doc/electra.md

712fe88

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

Update docs/source/en/model_doc/electra.md

034aeaf

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

Update docs/source/en/model_doc/electra.md

142bf6d

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

stevhliu reviewed Apr 1, 2025

View reviewed changes

Comment thread docs/source/en/model_doc/electra.md

stevhliu approved these changes Apr 2, 2025

View reviewed changes

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

Wu-n0 and others added 4 commits April 3, 2025 00:02

Update docs/source/en/model_doc/electra.md

cc80208

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

Update ELECTRA model card based on all review feedback

c8d3b12

Merge branch 'update-electra-model-card' of https://github.com/Wu-n0/…

3dcb0e6

…transformers into update-electra-model-card

Merge branch 'main' into update-electra-model-card

7f048cd

Wu-n0 requested a review from abdulazeem-tk4vr April 3, 2025 04:39

close hfoption block

6cf7861

stevhliu approved these changes Apr 3, 2025

View reviewed changes

stevhliu merged commit 8dd0a2b into huggingface:main Apr 3, 2025
10 checks passed

Wu-n0 deleted the update-electra-model-card branch April 3, 2025 20:59

stevhliu mentioned this pull request Jul 8, 2025

Improve ELECTRA documentation with explanations and helpful links #39262

Closed

MithraVardhan mentioned this pull request Oct 15, 2025

Standardize RoBERTa model card following issue #36979 #41597

Open

5 tasks

Conversation

Wu-n0 commented Mar 28, 2025

What does this PR do?

Before submitting

Who can review?

Uh oh!

github-actions Bot commented Mar 28, 2025

Uh oh!

Uh oh!

Uh oh!

stevhliu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HuggingFaceDocBuilderDev commented Mar 31, 2025

Uh oh!

Uh oh!

stevhliu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Wu-n0 commented Apr 3, 2025

Uh oh!

stevhliu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants