Updated BERTweet model card. #37981

RogerSinghChugh · 2025-05-06T16:26:35Z

What does this PR do?

As mentioned in the issue #36979 this PR updates the documentation of the BigBird model, which will now be aligned with the standardized format for all the docs.

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?

@stevhliu

github-actions · 2025-05-06T16:26:49Z

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

Thanks! 🤗

Let's also update the entry in the toctree from Bertweet to BERTweet.

docs/source/en/model_doc/bertweet.md

stevhliu · 2025-05-21T20:06:30Z

docs/source/en/model_doc/bertweet.md

->>> # from transformers import TFAutoModel
->>> # bertweet = TFAutoModel.from_pretrained("vinai/bertweet-base")
+```bash
+echo -e "Plants create <mask> through a process known as photosynthesis." | transformers-cli run --task fill-mask --model vinai/bertweet-base --device 0


Suggested change

echo -e "Plants create <mask> through a process known as photosynthesis." | transformers-cli run --task fill-mask --model vinai/bertweet-base --device 0

echo -e "Plants create <mask> through a process known as photosynthesis." | transformers run --task fill-mask --model vinai/bertweet-base --device 0

Hi @stevhliu, in a previous PR (for BART) you mentioned that I should leave the transformers-cli cmd as is, should I do that here as well? I might have mis understood what you meant.

Yeah sorry, this should still be transformers-cli run ...

docs/source/en/model_doc/bertweet.md

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

stevhliu

Thanks, once the transformers-cli run... command is fixed we can merge! Remember to fix the entry in the toctree from Bertweet to BERTweet

RogerSinghChugh · 2025-05-24T18:09:36Z

Bertweet

Hi @stevhliu , should I update toctree of all languages?

RogerSinghChugh · 2025-05-27T13:53:19Z

Bertweet

Hi @stevhliu , should I update toctree of all languages?

Hi @stevhliu just wanted to ask you about this. Thank you :)

stevhliu · 2025-05-27T17:52:03Z

No need to update the toctree for the other languages yet, thanks for checking!

Feel free to mark as ready for review when you're done 🤗

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

HuggingFaceDocBuilderDev · 2025-05-27T18:06:01Z

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 · 2025-05-27T18:07:28Z

Thanks, can you also push an empty commit here to trigger run_tests please?

…ghChugh/transformers into new_bertweet_model_card

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

…ghChugh/transformers into new_bertweet_model_card

RogerSinghChugh and others added 2 commits May 6, 2025 21:53

Updated BERTweet model card.

d287bf4

Merge branch 'main' into new_bertweet_model_card

419007e

github-actions bot marked this pull request as draft May 6, 2025 16:26

RogerSinghChugh mentioned this pull request May 6, 2025

[Community contributions] Model cards #36979

Open

stevhliu reviewed May 21, 2025

View reviewed changes

RogerSinghChugh and others added 7 commits May 22, 2025 23:28

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

3b8ceea

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

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

c613d24

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

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

b585ebc

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

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

b5e9d69

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

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

1ecb15f

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

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

d1d8f4f

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

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

67c8954

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

stevhliu approved these changes May 23, 2025

View reviewed changes

updated toctree (EN).

c92b390

RogerSinghChugh and others added 9 commits May 27, 2025 10:52

Updated BERTweet model card.

d513054

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

3a49a68

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

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

661bf0c

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

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

42e9fcf

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

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

448881a

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

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

3891562

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

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

11c05e9

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

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

61e6218

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

updated toctree (EN).

562c3c1

stevhliu force-pushed the new_bertweet_model_card branch from 9d77d40 to 562c3c1 Compare May 27, 2025 17:52

RogerSinghChugh marked this pull request as ready for review May 27, 2025 17:56

RogerSinghChugh and others added 10 commits May 27, 2025 23:40

Merge branch 'new_bertweet_model_card' of https://github.com/RogerSin…

53f72ff

…ghChugh/transformers into new_bertweet_model_card

Updated BERTweet model card.

aafd90b

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

47052bd

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

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

3daf357

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

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

241677e

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

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

ffdfe84

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

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

3068354

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

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

f41e66c

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

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

d850b53

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

updated toctree (EN).

3538e9b

stevhliu force-pushed the new_bertweet_model_card branch from 562c3c1 to 3538e9b Compare May 27, 2025 18:24

Merge branch 'new_bertweet_model_card' of https://github.com/RogerSin…

aad09a8

…ghChugh/transformers into new_bertweet_model_card

stevhliu merged commit 587c1b0 into huggingface:main May 27, 2025
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Updated BERTweet model card. #37981

Updated BERTweet model card. #37981

Uh oh!

RogerSinghChugh commented May 6, 2025

Uh oh!

github-actions bot commented May 6, 2025

Uh oh!

stevhliu left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevhliu May 21, 2025

Uh oh!

RogerSinghChugh May 22, 2025

Uh oh!

stevhliu May 23, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevhliu left a comment •

edited

Loading

Uh oh!

RogerSinghChugh commented May 24, 2025

Uh oh!

RogerSinghChugh commented May 27, 2025

Uh oh!

stevhliu commented May 27, 2025

Uh oh!

HuggingFaceDocBuilderDev commented May 27, 2025

Uh oh!

stevhliu commented May 27, 2025

Uh oh!

Uh oh!

Uh oh!

	echo -e "Plants create <mask> through a process known as photosynthesis." \| transformers-cli run --task fill-mask --model vinai/bertweet-base --device 0
	echo -e "Plants create <mask> through a process known as photosynthesis." \| transformers run --task fill-mask --model vinai/bertweet-base --device 0

Updated BERTweet model card. #37981

Updated BERTweet model card. #37981

Uh oh!

Conversation

RogerSinghChugh commented May 6, 2025

What does this PR do?

Before submitting

Who can review?

Uh oh!

github-actions bot commented May 6, 2025

Uh oh!

stevhliu left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevhliu May 21, 2025

Choose a reason for hiding this comment

Uh oh!

RogerSinghChugh May 22, 2025

Choose a reason for hiding this comment

Uh oh!

stevhliu May 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevhliu left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RogerSinghChugh commented May 24, 2025

Uh oh!

RogerSinghChugh commented May 27, 2025

Uh oh!

stevhliu commented May 27, 2025

Uh oh!

HuggingFaceDocBuilderDev commented May 27, 2025

Uh oh!

stevhliu commented May 27, 2025

Uh oh!

Uh oh!

Uh oh!

stevhliu left a comment •

edited

Loading

stevhliu left a comment •

edited

Loading