Skip to content

Standardize BertGeneration model card #40250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

nemitha2005
Copy link

@nemitha2005 nemitha2005 commented Aug 18, 2025

What does this PR do?

#36979

Updated the BertGeneration model card to follow the new standardized format including:

  • New consistent layout with badges
  • Friendly description written for accessibility
  • Usage examples with Pipeline, AutoModel, and transformers-cli
  • Quantization example with BitsAndBytesConfig
  • Updated resources section with proper links

This standardizes the BertGeneration documentation to match the new template format requested in issue #36979.

Before submitting

Who can review?

@stevhliu - Documentation lead who is managing the model card standardization project.

Anyone in the community is free to review the PR once the tests have passed.

Copy link
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!


## Notes

- BertGenerationEncoder and BertGenerationDecoder should be used in combination with EncoderDecoderModel for sequence-to-sequence tasks.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- BertGenerationEncoder and BertGenerationDecoder should be used in combination with EncoderDecoderModel for sequence-to-sequence tasks.
- [`BertGenerationEncoder`] and [`BertGenerationDecoder`] should be used in combination with [`EncoderDecoderModel`] for sequence-to-sequence tasks.
<add code example here from https://huggingface.co/docs/transformers/model_doc/bert-generation#usage-examples-and-tips>

Copy link
Member

Choose a reason for hiding this comment

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

Missing a code example that shows how to use two pretrained google-bert/bert-large-uncased checkpoints

@nemitha2005 nemitha2005 force-pushed the standardize-bert-generation-model-card branch from 2468d4b to 7a34d08 Compare August 19, 2025 09:57
@nemitha2005
Copy link
Author

Thanks for the feedback! I've applied all your suggestions.

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.

2 participants