Skip to content

Updated CamemBERT model card to new standardized format#39227

Merged
stevhliu merged 6 commits intohuggingface:mainfrom
MShaheerMalik77:update-camembert-model-card
Jul 11, 2025
Merged

Updated CamemBERT model card to new standardized format#39227
stevhliu merged 6 commits intohuggingface:mainfrom
MShaheerMalik77:update-camembert-model-card

Conversation

@MShaheerMalik77
Copy link
Copy Markdown
Contributor

@MShaheerMalik77 MShaheerMalik77 commented Jul 4, 2025 •
edited
Loading

What does this PR do?

This PR updates the CamemBERT model card camembert.md, by standardizing its format according to #36979. It includes example code for performing masked language modelling with the pipeline and AutoModel classes, as well as a Quantization example.

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 do let me know if you'd like me to make any changes!

@ArthurZucker ArthurZucker requested a review from stevhliu July 7, 2025 13:07
@stevhliu stevhliu mentioned this pull request Jul 7, 2025
Closed
stevhliu
stevhliu reviewed Jul 7, 2025
View reviewed changes
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.

Good start!

Comment thread docs/source/en/model_doc/camembert.md Outdated
Comment thread docs/source/en/model_doc/camembert.md
Comment thread docs/source/en/model_doc/camembert.md
Comment thread docs/source/en/model_doc/camembert.md Outdated
Comment thread docs/source/en/model_doc/camembert.md
Comment thread docs/source/en/model_doc/camembert.md Outdated
Comment thread docs/source/en/model_doc/camembert.md
Comment thread docs/source/en/model_doc/camembert.md Outdated
Comment thread docs/source/en/model_doc/camembert.md
Comment thread docs/source/en/model_doc/camembert.md Outdated
@MShaheerMalik77
Copy link
Copy Markdown
Contributor Author

MShaheerMalik77 commented Jul 9, 2025

Hi @stevhliu! I've added all the suggested changes to the CamemBERT model card, please let me know if there's anything else you'd like me to update!

@MShaheerMalik77 MShaheerMalik77 force-pushed the update-camembert-model-card branch from 652abb9 to a5dd7e1 Compare July 9, 2025 17:37
stevhliu
stevhliu reviewed Jul 9, 2025
View reviewed changes
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, there are still some unresolved comments and the API references are scattered throughout the doc rather than having their own section

Comment thread docs/source/en/model_doc/camembert.md
Comment thread docs/source/en/model_doc/camembert.md Outdated
## CamembertForMultipleChoice

[[autodoc]] CamembertForMultipleChoice
You can also use CamemBERT for multiple-choice tasks via the command line:
Copy link
Copy Markdown
Member

@stevhliu stevhliu Jul 9, 2025

Choose a reason for hiding this comment

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

Add this to the blocks above and make sure the example matches that of the Pipeline and AutoModel for consistency. See the BERT docs for an example

Comment thread docs/source/en/model_doc/camembert.md Outdated
@MShaheerMalik77
Copy link
Copy Markdown
Contributor Author

MShaheerMalik77 commented Jul 10, 2025

Hi @stevhliu. I went through all unresolved issues, applied all the suggestions and re-added the api references in the proper format. Please do let me know if there's anything you would like me to adjust!

stevhliu
stevhliu approved these changes Jul 10, 2025
View reviewed changes
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, just a few more things and then we can merge!

Comment thread docs/source/en/model_doc/camembert.md Outdated
</hfoption>

</Tip>
<hfoption id="Command line">
Copy link
Copy Markdown
Member

@stevhliu stevhliu Jul 10, 2025

Choose a reason for hiding this comment

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

Suggested change
<hfoption id="Command line">
<hfoption id="transformers CLI">

Comment thread docs/source/en/model_doc/camembert.md
<hfoption id="Command line">

## Resources
```bash
Copy link
Copy Markdown
Member

@stevhliu stevhliu Jul 10, 2025

Choose a reason for hiding this comment

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

echo -e "Le camembert est un délicieux fromage <mask>." | transformers run --task fill-mask --model camembert-base --device 0

@MShaheerMalik77
Copy link
Copy Markdown
Contributor Author

MShaheerMalik77 commented Jul 11, 2025

Hi @stevhliu , I have incorporated remaining suggestions to the model document, let me know if there are any further changes you'd like me to make!

@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

HuggingFaceDocBuilderDev commented Jul 11, 2025

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 a646fd5 into huggingface:main Jul 11, 2025
15 checks passed
rjgleaton pushed a commit to rjgleaton/transformers that referenced this pull request Jul 17, 2025
@MShaheerMalik77 @rjgleaton
Updated CamemBERT model card to new standardized format (huggingface#…
e990cb0 
…39227)

* Updated CamemBERT model card to new standardized format

* Applied review suggestions for CamemBERT: restored API refs, added examples, badges, and attribution

* Updated CamemBERT usage examples, quantization, badges, and format

* Updated CamemBERT badges

* Fixed CLI Section
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@MShaheerMalik77 @zaristei
Updated CamemBERT model card to new standardized format (huggingface#…
c722422 
…39227)

* Updated CamemBERT model card to new standardized format

* Applied review suggestions for CamemBERT: restored API refs, added examples, badges, and attribution

* Updated CamemBERT usage examples, quantization, badges, and format

* Updated CamemBERT badges

* Fixed CLI Section
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@MShaheerMalik77 @zaristei
Updated CamemBERT model card to new standardized format (huggingface#…
d3621f1 
…39227)

* Updated CamemBERT model card to new standardized format

* Applied review suggestions for CamemBERT: restored API refs, added examples, badges, and attribution

* Updated CamemBERT usage examples, quantization, badges, and format

* Updated CamemBERT badges

* Fixed CLI Section
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@MShaheerMalik77 @zaristei
Updated CamemBERT model card to new standardized format (huggingface#…
e64a453 
…39227)

* Updated CamemBERT model card to new standardized format

* Applied review suggestions for CamemBERT: restored API refs, added examples, badges, and attribution

* Updated CamemBERT usage examples, quantization, badges, and format

* Updated CamemBERT badges

* Fixed CLI Section
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@MShaheerMalik77 @zaristei
Updated CamemBERT model card to new standardized format (huggingface#…
26cddce 
…39227)

* Updated CamemBERT model card to new standardized format

* Applied review suggestions for CamemBERT: restored API refs, added examples, badges, and attribution

* Updated CamemBERT usage examples, quantization, badges, and format

* Updated CamemBERT badges

* Fixed CLI Section
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@MShaheerMalik77 @zaristei
Updated CamemBERT model card to new standardized format (huggingface#…
41f7968 
…39227)

* Updated CamemBERT model card to new standardized format

* Applied review suggestions for CamemBERT: restored API refs, added examples, badges, and attribution

* Updated CamemBERT usage examples, quantization, badges, and format

* Updated CamemBERT badges

* Fixed CLI Section
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@MShaheerMalik77 @zaristei
Updated CamemBERT model card to new standardized format (huggingface#…
75286a0 
…39227)

* Updated CamemBERT model card to new standardized format

* Applied review suggestions for CamemBERT: restored API refs, added examples, badges, and attribution

* Updated CamemBERT usage examples, quantization, badges, and format

* Updated CamemBERT badges

* Fixed CLI Section
zaristei pushed a commit to zaristei/transformers that referenced this pull request Sep 9, 2025
@MShaheerMalik77 @zaristei
Updated CamemBERT model card to new standardized format (huggingface#…
db2c2cf 
…39227)

* Updated CamemBERT model card to new standardized format

* Applied review suggestions for CamemBERT: restored API refs, added examples, badges, and attribution

* Updated CamemBERT usage examples, quantization, badges, and format

* Updated CamemBERT badges

* Fixed CLI Section
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stevhliu stevhliu stevhliu approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@MShaheerMalik77 @HuggingFaceDocBuilderDev @stevhliu