-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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.
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
Updated CamemBERT model card to new standardized format #39227
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good start!
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! |
…amples, badges, and attribution
652abb9
to
a5dd7e1
Compare
There was a problem hiding this 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
@@ -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: |
There was a problem hiding this comment.
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
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! |
There was a problem hiding this 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!
|
||
</Tip> | ||
<hfoption id="Command line"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<hfoption id="Command line"> | |
<hfoption id="transformers CLI"> |
|
||
## Resources | ||
```bash |
There was a problem hiding this comment.
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
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! |
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. |
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
Pull Request section?
to it if that's the case.
documentation guidelines, and
here are tips on formatting docstrings.
Who can review?
@stevhliu please do let me know if you'd like me to make any changes!