Skip to content

Created model card for XLM model#38595

Merged
stevhliu merged 3 commits intohuggingface:mainfrom
AshAnand34:xlm-model-card
Jun 9, 2025
Merged

Created model card for XLM model#38595
stevhliu merged 3 commits intohuggingface:mainfrom
AshAnand34:xlm-model-card

Conversation

@AshAnand34
Copy link
Copy Markdown
Contributor

What does this PR do?

This pull request updates the XLM model documentation to improve clarity, add usage examples, and enhance the overall presentation. The changes include a new layout for badges, detailed usage examples with code snippets, and reorganized content for better readability as outlined in #36979.

Documentation Enhancements:

  • Added a floating badge section for PyTorch and TensorFlow at the top of the page to visually highlight supported frameworks.
  • Included detailed usage examples for masked language modeling using both the Pipeline and AutoModel classes, complete with Python code snippets.

Content Reorganization:

  • Rewrote and reorganized the "Overview" and "Model Details" sections to improve clarity and readability. Key features and training objectives are now presented in a concise bullet-point format.
  • Moved usage tips to a dedicated "Usage Tips" section, emphasizing the importance of selecting the correct checkpoint and using the lang parameter for multilingual tasks.

Additional Features:

  • Added a "TIP" section to guide users to explore more examples of XLM applications via the sidebar.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).

Who can review?

@stevhliu

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! See my comments on your other PRs and apply them to this one as well :)

Comment thread docs/source/en/model_doc/xlm.md Outdated
Comment thread docs/source/en/model_doc/xlm.md Outdated
Comment thread docs/source/en/model_doc/xlm.md Outdated
Comment thread docs/source/en/model_doc/xlm.md Outdated
Comment thread docs/source/en/model_doc/xlm.md
Comment thread docs/source/en/model_doc/xlm.md Outdated
Comment thread docs/source/en/model_doc/xlm.md Outdated
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 for your contribution!

@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 stevhliu merged commit 29ca043 into huggingface:main Jun 9, 2025
10 checks passed
bvantuan pushed a commit to bvantuan/transformers that referenced this pull request Jun 12, 2025
* Created model card for XLM model

* Revised model card structure and content of XLM model

* Update XLM model documentation with improved examples and code snippets for predicting <mask> tokens using Pipeline and AutoModel.
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