Skip to content

Updated CamemBERT model card to new standardized format #39227

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Jul 11, 2025
Merged

Updated CamemBERT model card to new standardized format #39227

merged 6 commits into from
Jul 11, 2025

Conversation

MShaheerMalik77
Copy link
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
Open
stevhliu
stevhliu reviewed Jul 7, 2025
View reviewed changes
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.

Good start!

@MShaheerMalik77
Copy link
Contributor Author

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
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

docs/source/en/model_doc/camembert.md Outdated
@@ -95,13 +98,61 @@ as the information relative to the inputs and outputs.

## CamembertForMultipleChoice

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

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

@MShaheerMalik77
Copy link
Contributor Author

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

docs/source/en/model_doc/camembert.md Outdated

</Tip>
<hfoption id="Command line">
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
<hfoption id="Command line">
<hfoption id="transformers CLI">

docs/source/en/model_doc/camembert.md

## Resources
```bash
Copy link
Member

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
Contributor Author

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

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
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