Skip to content

New bart model card#37858

Merged
stevhliu merged 23 commits intohuggingface:mainfrom
RogerSinghChugh:new_bart_model_card
May 27, 2025
Merged

New bart model card#37858
stevhliu merged 23 commits intohuggingface:mainfrom
RogerSinghChugh:new_bart_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 BART 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, please let me know if any changes are needed.

@github-actions github-actions Bot marked this pull request as draft April 29, 2025 11:15
@github-actions
Copy link
Copy Markdown
Contributor

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!

Comment thread docs/source/en/model_doc/bart.md Outdated
Comment thread docs/source/en/model_doc/bart.md Outdated
Comment thread docs/source/en/model_doc/bart.md Outdated
Comment thread docs/source/en/model_doc/bart.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 facebook/bart-large --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.

Suggested change
echo -e "Plants create <mask> through a process known as photosynthesis." | transformers-cli run --task fill-mask --model facebook/bart-large --device 0
echo -e "Plants create <mask> through a process known as photosynthesis." | transformers run --task fill-mask --model facebook/bart-large --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.

Hey just wanted to know the reason for this, I tried to run this command but got an error "transformers: command not found" @stevhliu

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 just wanted to ask you about this.

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 just wanted some clarity on this, thanks.

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.

Hey sorry, you can actually leave it as it is! This only applies to the chat command at the moment, and run will be updated later in the future.

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.

Sure no worries, so I'll leave it as is.

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.
I think I have a doubt here. Do you want me to remove the '-cli' when you say I should leave it as is? If 'run' cmd will be updated in the future then wont the cli cmd not run right now?

Comment thread docs/source/en/model_doc/bart.md Outdated
Comment thread docs/source/en/model_doc/bart.md Outdated
RogerSinghChugh and others added 11 commits May 1, 2025 19:50
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>
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, feel free to mark as ready for review and then we can merge!

<hfoption id="transformers-cli">

```bash
echo -e "Plants create <mask> through a process known as photosynthesis." | transformers-cli run --task fill-mask --model facebook/bart-large --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.

Hey sorry, you can actually leave it as it is! This only applies to the chat command at the moment, and run will be updated later in the future.

@RogerSinghChugh RogerSinghChugh marked this pull request as ready for review May 22, 2025 17:52
@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
Copy link
Copy Markdown
Member

stevhliu commented May 23, 2025

Thanks again, can you push an empty commit to trigger the run_tests check (or you can also rebase) :)

@RogerSinghChugh
Copy link
Copy Markdown
Contributor Author

Thanks again, can you push an empty commit to trigger the run_tests check (or you can also rebase) :)

Hi, just did :)

@RogerSinghChugh
Copy link
Copy Markdown
Contributor Author

Thanks again, can you push an empty commit to trigger the run_tests check (or you can also rebase) :)

Hi, just did :)

Hi @stevhliu, just a reminder for this.

@stevhliu stevhliu merged commit be7aa32 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