Skip to content

Updated BigBird Model card as per #36979.#37959

Merged
stevhliu merged 13 commits intohuggingface:mainfrom
RogerSinghChugh:new_big_bird_model_card
May 27, 2025
Merged

Updated BigBird Model card as per #36979.#37959
stevhliu merged 13 commits intohuggingface:mainfrom
RogerSinghChugh:new_big_bird_model_card

Conversation

@RogerSinghChugh
Copy link
Copy Markdown
Contributor

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 github-actions Bot marked this pull request as draft May 5, 2025 12:22
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2025

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.

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.

Great job, only have minor comments to add! Feel free to mark it as ready once all comments have been resolved 🤗

Comment thread docs/source/en/model_doc/big_bird.md Outdated
Comment thread docs/source/en/model_doc/big_bird.md Outdated
<hfoption id="transformers CLI">

```bash
!echo -e "Plants create [MASK] through a process known as photosynthesis." | transformers-cli run --task fill-mask --model google/bigbird-roberta-base --device 0
Copy link
Copy Markdown
Member

@stevhliu stevhliu May 21, 2025

Choose a reason for hiding this comment

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

Suggested change
!echo -e "Plants create [MASK] through a process known as photosynthesis." | transformers-cli run --task fill-mask --model google/bigbird-roberta-base --device 0
!echo -e "Plants create [MASK] through a process known as photosynthesis." | transformers-cli run --task fill-mask --model google/bigbird-roberta-base --device 0

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah, sorry about the misunderstanding. This should still be transformers-cli run .... It is only simplified for the chat command where you can do transformers chat ...

Comment thread docs/source/en/model_doc/big_bird.md Outdated
Comment thread docs/source/en/model_doc/big_bird.md Outdated
RogerSinghChugh and others added 5 commits May 22, 2025 23:23
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
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, we can merge once the transformers-cli run command is fixed!

<hfoption id="transformers CLI">

```bash
!echo -e "Plants create [MASK] through a process known as photosynthesis." | transformers-cli run --task fill-mask --model google/bigbird-roberta-base --device 0
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah, sorry about the misunderstanding. This should still be transformers-cli run .... It is only simplified for the chat command where you can do transformers chat ...

@RogerSinghChugh RogerSinghChugh marked this pull request as ready for review May 24, 2025 18:12
@RogerSinghChugh
Copy link
Copy Markdown
Contributor Author

Hi @stevhliu so is there anything to be done from my side then? Thanks :)

@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

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 b73faef into huggingface:main May 27, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants